From 468a001a813cc81f2379da43c7bf25c285f89d6e Mon Sep 17 00:00:00 2001 From: Dragios Date: Sat, 16 Apr 2016 01:12:27 +0800 Subject: [PATCH] CPU JIT Part 2 (#4) * ARM/Decoder: Initial implementation * JitX64: Implement register allocator * JitX64: Initial implementation of JitX64 compiler * JitX64: Add accessors for ARMul_State::exclusive_tag and ARMul_State::exclusive_state * JitX64: Implement ARM_Jit ARM_Jit is the ARM_Interface for the x64 recompiler. * tests: Infrastructure for unit tests * dyncom: Implement Arm_DynCom::ClearCache() * tests/JitX64: Fuzz ARM data processing instructions * JitX64: Implement ARM_Jit::ClearCache() * JitX64: Implement ADC_imm * JitX64: Implement immediate data processing instructions * fixup! Arm/ArmDecoder: Address comments regarding the arm decoder and check versions of all arm instructions * fixup! Builds on OS X now * fixup! Fix bugs in thumb decoder & have it use boost::optional * JitX64/RegAlloc: Improve documentation and improve method names * tests/JitX64: Improve tests * tests/JitX64: Add tests for testing data processing instructions with Rd=R15 * fixup! JitX64/RegAlloc: Rename member functions to (Lock|Bind)ArmFor(Read|ReadWrite|Write). * fixup! Addressed comments regarding JitX64::JitX64 * fixup! tests/JitX64: Address comments * tests/JitX64: Initial thumb tests * Common: Add MathUtil::SignExtend * ARM_Disasm: Disassemble BLX * JitX64: Implement branch instructions * JitX64: Implement 32-bit thumb BL(X) instruction * JitX64: Data Processing: Implement shift-by-immediate (_reg) instructions * JitX64: Data Processing: Implement shift-by-register (_rsr) instructions * x64 ABI: Be explicit about Gen:: namespace * MMIO: UnmapRegion * JitX64: Implement load/store instructions * JitX64: Implement load and store multiple * JitX64: Implement SETEND * tests/JitX64: Improve thumb instruction test coverage * fixup! Fix non-MSVC builds * JitX64: Load/Store: Add UNPREDICTABLE ASSERTs, correct LDR R15 behavior * tests/JitX64: Fix thumb tests * JitX64: Implement synchronisation instructions * JitX64: Implement exception-generating instructions * ARM_Jit: ClearCache upon construct * ARM/Decoder: Fill out more instructions * JitX64: Removed old page table code * fixup! ARM/Decoder: Various fixes * Use C++14 std::integer_sequence. * Split ArmDecoder::Instruction into ArmInstruction and ThumbInstruction * Make Cond, Register, ShiftType and SignExtendRotation enum classes. * ThumbMatcher is no longer allocated on the heap. * JitX64::CondManager now uses Cond instead of SkyEye's ConditionCode. * Add utility functions IsArmRegValid and MakeArmRegList. * fixup! ARM/Decoder: Misc fixes * fixup! Common: Move SignExtend and bits into BitUtil * fixup! arm_dyncom_interpreter * fixup! JitState: Should be final and should have initial values * fixup! Make JitX64::CondManager::CurrentCond() const * fixup! JitX64: Move thumb_BLX_* variables below ArmDecoder::Visitor functions * fixup! RegAlloc: Simplify code * fixup! MMIO: UnmapRegion * fixup! Tests/JitX64: Use std::generate_n and factor pass-testing into DoesBehaviorMatch * fixup! JitX64::LocationDescriptorHash: Use static_cast * fixup! JitX64: Default values for primitive members * fixup! JitX64: Add const to relevant member functions, add initialisers to members of CondManager * fixup! Jit: Remove unnecessary headers * fixup! RunJittedCode: Remove C-style casts * fixup! Common: Common::make_unique -> std::make_unique * fixup! BitUtils * fixup! JitX64: reinterpret_cast -> reinterpret_cast * fixup! static -> inline in headers, moved instruction/helper/load_store.h function bodies into .cpp file * fixup! Move public interface of JitX64 class to the top * fixup! Rename JitX64::UpdateFlags* so flag names are in order (N, Z, C, V) * fixup! BitUtil: Correct error messages, independent impl of Bit, correct SignExtend logic --- externals/catch/catch.hpp | 10445 ++++++++++++++++ src/CMakeLists.txt | 1 + src/common/CMakeLists.txt | 1 + src/common/bit_util.h | 47 + src/common/common_funcs.h | 24 +- src/common/math_util.h | 7 +- src/common/x64/abi.h | 28 +- src/core/CMakeLists.txt | 43 + src/core/arm/arm_interface.h | 3 + src/core/arm/decoder/arm.cpp | 393 + src/core/arm/decoder/decoder.h | 415 + src/core/arm/decoder/thumb.cpp | 438 + src/core/arm/disassembler/arm_disasm.cpp | 24 +- src/core/arm/disassembler/arm_disasm.h | 1 + src/core/arm/dyncom/arm_dyncom.cpp | 6 + src/core/arm/dyncom/arm_dyncom.h | 2 + .../arm/dyncom/arm_dyncom_interpreter.cpp | 7 + src/core/arm/dyncom/arm_dyncom_interpreter.h | 1 + src/core/arm/jit_x64/common.h | 56 + src/core/arm/jit_x64/cond.cpp | 146 + src/core/arm/jit_x64/instructions/branch.cpp | 120 + .../arm/jit_x64/instructions/coprocessor.cpp | 17 + .../jit_x64/instructions/data_processing.cpp | 1435 +++ .../instructions/exception_generating.cpp | 68 + .../arm/jit_x64/instructions/extension.cpp | 22 + .../instructions/helper/load_store.cpp | 73 + .../jit_x64/instructions/helper/load_store.h | 33 + src/core/arm/jit_x64/instructions/hint.cpp | 15 + .../arm/jit_x64/instructions/load_store.cpp | 1035 ++ src/core/arm/jit_x64/instructions/misc.cpp | 13 + .../arm/jit_x64/instructions/multiply.cpp | 42 + src/core/arm/jit_x64/instructions/packing.cpp | 12 + .../parallel_add_subtract_halving.cpp | 22 + .../parallel_add_subtract_modulo.cpp | 22 + .../parallel_add_subtract_saturating.cpp | 22 + .../arm/jit_x64/instructions/qadd_qsub.cpp | 14 + .../arm/jit_x64/instructions/reversal.cpp | 13 + .../arm/jit_x64/instructions/saturation.cpp | 14 + .../jit_x64/instructions/status_register.cpp | 32 + .../jit_x64/instructions/synchronisation.cpp | 297 + src/core/arm/jit_x64/instructions/thumb.cpp | 100 + src/core/arm/jit_x64/instructions/usad.cpp | 12 + src/core/arm/jit_x64/interface.cpp | 238 + src/core/arm/jit_x64/interface.h | 54 + src/core/arm/jit_x64/interpret.cpp | 63 + src/core/arm/jit_x64/jit_x64.cpp | 265 + src/core/arm/jit_x64/jit_x64.h | 432 + src/core/arm/jit_x64/reg_alloc.cpp | 383 + src/core/arm/jit_x64/reg_alloc.h | 210 + src/core/arm/skyeye_common/armstate.h | 1 - src/core/memory.cpp | 9 +- src/core/memory_setup.h | 1 + src/tests/CMakeLists.txt | 47 + .../core/arm/jit_x64/fuzz_arm_branch.cpp | 39 + .../core/arm/jit_x64/fuzz_arm_common.cpp | 206 + src/tests/core/arm/jit_x64/fuzz_arm_common.h | 22 + .../arm/jit_x64/fuzz_arm_data_processing.cpp | 115 + .../core/arm/jit_x64/fuzz_arm_load_store.cpp | 156 + src/tests/core/arm/jit_x64/fuzz_thumb.cpp | 335 + src/tests/core/arm/jit_x64/rand_int.h | 20 + src/tests/tests.cpp | 9 + 61 files changed, 18094 insertions(+), 32 deletions(-) create mode 100644 externals/catch/catch.hpp create mode 100644 src/common/bit_util.h create mode 100644 src/core/arm/decoder/arm.cpp create mode 100644 src/core/arm/decoder/decoder.h create mode 100644 src/core/arm/decoder/thumb.cpp create mode 100644 src/core/arm/jit_x64/common.h create mode 100644 src/core/arm/jit_x64/cond.cpp create mode 100644 src/core/arm/jit_x64/instructions/branch.cpp create mode 100644 src/core/arm/jit_x64/instructions/coprocessor.cpp create mode 100644 src/core/arm/jit_x64/instructions/data_processing.cpp create mode 100644 src/core/arm/jit_x64/instructions/exception_generating.cpp create mode 100644 src/core/arm/jit_x64/instructions/extension.cpp create mode 100644 src/core/arm/jit_x64/instructions/helper/load_store.cpp create mode 100644 src/core/arm/jit_x64/instructions/helper/load_store.h create mode 100644 src/core/arm/jit_x64/instructions/hint.cpp create mode 100644 src/core/arm/jit_x64/instructions/load_store.cpp create mode 100644 src/core/arm/jit_x64/instructions/misc.cpp create mode 100644 src/core/arm/jit_x64/instructions/multiply.cpp create mode 100644 src/core/arm/jit_x64/instructions/packing.cpp create mode 100644 src/core/arm/jit_x64/instructions/parallel_add_subtract_halving.cpp create mode 100644 src/core/arm/jit_x64/instructions/parallel_add_subtract_modulo.cpp create mode 100644 src/core/arm/jit_x64/instructions/parallel_add_subtract_saturating.cpp create mode 100644 src/core/arm/jit_x64/instructions/qadd_qsub.cpp create mode 100644 src/core/arm/jit_x64/instructions/reversal.cpp create mode 100644 src/core/arm/jit_x64/instructions/saturation.cpp create mode 100644 src/core/arm/jit_x64/instructions/status_register.cpp create mode 100644 src/core/arm/jit_x64/instructions/synchronisation.cpp create mode 100644 src/core/arm/jit_x64/instructions/thumb.cpp create mode 100644 src/core/arm/jit_x64/instructions/usad.cpp create mode 100644 src/core/arm/jit_x64/interface.cpp create mode 100644 src/core/arm/jit_x64/interface.h create mode 100644 src/core/arm/jit_x64/interpret.cpp create mode 100644 src/core/arm/jit_x64/jit_x64.cpp create mode 100644 src/core/arm/jit_x64/jit_x64.h create mode 100644 src/core/arm/jit_x64/reg_alloc.cpp create mode 100644 src/core/arm/jit_x64/reg_alloc.h create mode 100644 src/tests/CMakeLists.txt create mode 100644 src/tests/core/arm/jit_x64/fuzz_arm_branch.cpp create mode 100644 src/tests/core/arm/jit_x64/fuzz_arm_common.cpp create mode 100644 src/tests/core/arm/jit_x64/fuzz_arm_common.h create mode 100644 src/tests/core/arm/jit_x64/fuzz_arm_data_processing.cpp create mode 100644 src/tests/core/arm/jit_x64/fuzz_arm_load_store.cpp create mode 100644 src/tests/core/arm/jit_x64/fuzz_thumb.cpp create mode 100644 src/tests/core/arm/jit_x64/rand_int.h create mode 100644 src/tests/tests.cpp diff --git a/externals/catch/catch.hpp b/externals/catch/catch.hpp new file mode 100644 index 000000000..2a7146a7f --- /dev/null +++ b/externals/catch/catch.hpp @@ -0,0 +1,10445 @@ +/* + * Catch v1.4.0 + * Generated: 2016-03-15 07:23:12.623111 + * ---------------------------------------------------------- + * This file has been merged from multiple headers. Please don't edit it directly + * Copyright (c) 2012 Two Blue Cubes Ltd. All rights reserved. + * + * Distributed under the Boost Software License, Version 1.0. (See accompanying + * file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) + */ +#ifndef TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED +#define TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED + +#define TWOBLUECUBES_CATCH_HPP_INCLUDED + +#ifdef __clang__ +# pragma clang system_header +#elif defined __GNUC__ +# pragma GCC system_header +#endif + +// #included from: internal/catch_suppress_warnings.h + +#ifdef __clang__ +# ifdef __ICC // icpc defines the __clang__ macro +# pragma warning(push) +# pragma warning(disable: 161 1682) +# else // __ICC +# pragma clang diagnostic ignored "-Wglobal-constructors" +# pragma clang diagnostic ignored "-Wvariadic-macros" +# pragma clang diagnostic ignored "-Wc99-extensions" +# pragma clang diagnostic ignored "-Wunused-variable" +# pragma clang diagnostic push +# pragma clang diagnostic ignored "-Wpadded" +# pragma clang diagnostic ignored "-Wc++98-compat" +# pragma clang diagnostic ignored "-Wc++98-compat-pedantic" +# pragma clang diagnostic ignored "-Wswitch-enum" +# pragma clang diagnostic ignored "-Wcovered-switch-default" +# endif +#elif defined __GNUC__ +# pragma GCC diagnostic ignored "-Wvariadic-macros" +# pragma GCC diagnostic ignored "-Wunused-variable" +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wpadded" +#endif +#if defined(CATCH_CONFIG_MAIN) || defined(CATCH_CONFIG_RUNNER) +# define CATCH_IMPL +#endif + +#ifdef CATCH_IMPL +# ifndef CLARA_CONFIG_MAIN +# define CLARA_CONFIG_MAIN_NOT_DEFINED +# define CLARA_CONFIG_MAIN +# endif +#endif + +// #included from: internal/catch_notimplemented_exception.h +#define TWOBLUECUBES_CATCH_NOTIMPLEMENTED_EXCEPTION_H_INCLUDED + +// #included from: catch_common.h +#define TWOBLUECUBES_CATCH_COMMON_H_INCLUDED + +#define INTERNAL_CATCH_UNIQUE_NAME_LINE2( name, line ) name##line +#define INTERNAL_CATCH_UNIQUE_NAME_LINE( name, line ) INTERNAL_CATCH_UNIQUE_NAME_LINE2( name, line ) +#ifdef CATCH_CONFIG_COUNTER +# define INTERNAL_CATCH_UNIQUE_NAME( name ) INTERNAL_CATCH_UNIQUE_NAME_LINE( name, __COUNTER__ ) +#else +# define INTERNAL_CATCH_UNIQUE_NAME( name ) INTERNAL_CATCH_UNIQUE_NAME_LINE( name, __LINE__ ) +#endif + +#define INTERNAL_CATCH_STRINGIFY2( expr ) #expr +#define INTERNAL_CATCH_STRINGIFY( expr ) INTERNAL_CATCH_STRINGIFY2( expr ) + +#include +#include +#include + +// #included from: catch_compiler_capabilities.h +#define TWOBLUECUBES_CATCH_COMPILER_CAPABILITIES_HPP_INCLUDED + +// Detect a number of compiler features - mostly C++11/14 conformance - by compiler +// The following features are defined: +// +// CATCH_CONFIG_CPP11_NULLPTR : is nullptr supported? +// CATCH_CONFIG_CPP11_NOEXCEPT : is noexcept supported? +// CATCH_CONFIG_CPP11_GENERATED_METHODS : The delete and default keywords for compiler generated methods +// CATCH_CONFIG_CPP11_IS_ENUM : std::is_enum is supported? +// CATCH_CONFIG_CPP11_TUPLE : std::tuple is supported +// CATCH_CONFIG_CPP11_LONG_LONG : is long long supported? +// CATCH_CONFIG_CPP11_OVERRIDE : is override supported? +// CATCH_CONFIG_CPP11_UNIQUE_PTR : is unique_ptr supported (otherwise use auto_ptr) + +// CATCH_CONFIG_CPP11_OR_GREATER : Is C++11 supported? + +// CATCH_CONFIG_VARIADIC_MACROS : are variadic macros supported? +// CATCH_CONFIG_COUNTER : is the __COUNTER__ macro supported? +// **************** +// Note to maintainers: if new toggles are added please document them +// in configuration.md, too +// **************** + +// In general each macro has a _NO_ form +// (e.g. CATCH_CONFIG_CPP11_NO_NULLPTR) which disables the feature. +// Many features, at point of detection, define an _INTERNAL_ macro, so they +// can be combined, en-mass, with the _NO_ forms later. + +// All the C++11 features can be disabled with CATCH_CONFIG_NO_CPP11 + +#if defined(__cplusplus) && __cplusplus >= 201103L +# define CATCH_CPP11_OR_GREATER +#endif + +#ifdef __clang__ + +# if __has_feature(cxx_nullptr) +# define CATCH_INTERNAL_CONFIG_CPP11_NULLPTR +# endif + +# if __has_feature(cxx_noexcept) +# define CATCH_INTERNAL_CONFIG_CPP11_NOEXCEPT +# endif + +# if defined(CATCH_CPP11_OR_GREATER) +# define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS _Pragma( "clang diagnostic ignored \"-Wparentheses\"" ) +# endif + +#endif // __clang__ + +//////////////////////////////////////////////////////////////////////////////// +// Borland +#ifdef __BORLANDC__ + +#endif // __BORLANDC__ + +//////////////////////////////////////////////////////////////////////////////// +// EDG +#ifdef __EDG_VERSION__ + +#endif // __EDG_VERSION__ + +//////////////////////////////////////////////////////////////////////////////// +// Digital Mars +#ifdef __DMC__ + +#endif // __DMC__ + +//////////////////////////////////////////////////////////////////////////////// +// GCC +#ifdef __GNUC__ + +# if __GNUC__ == 4 && __GNUC_MINOR__ >= 6 && defined(__GXX_EXPERIMENTAL_CXX0X__) +# define CATCH_INTERNAL_CONFIG_CPP11_NULLPTR +# endif + +# if !defined(CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS) && defined(CATCH_CPP11_OR_GREATER) +# define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS _Pragma( "GCC diagnostic ignored \"-Wparentheses\"" ) +# endif + +// - otherwise more recent versions define __cplusplus >= 201103L +// and will get picked up below + +#endif // __GNUC__ + +//////////////////////////////////////////////////////////////////////////////// +// Visual C++ +#ifdef _MSC_VER + +#if (_MSC_VER >= 1600) +# define CATCH_INTERNAL_CONFIG_CPP11_NULLPTR +# define CATCH_INTERNAL_CONFIG_CPP11_UNIQUE_PTR +#endif + +#if (_MSC_VER >= 1900 ) // (VC++ 13 (VS2015)) +#define CATCH_INTERNAL_CONFIG_CPP11_NOEXCEPT +#define CATCH_INTERNAL_CONFIG_CPP11_GENERATED_METHODS +#endif + +#endif // _MSC_VER + +//////////////////////////////////////////////////////////////////////////////// + +// Use variadic macros if the compiler supports them +#if ( defined _MSC_VER && _MSC_VER > 1400 && !defined __EDGE__) || \ + ( defined __WAVE__ && __WAVE_HAS_VARIADICS ) || \ + ( defined __GNUC__ && __GNUC__ >= 3 ) || \ + ( !defined __cplusplus && __STDC_VERSION__ >= 199901L || __cplusplus >= 201103L ) + +#define CATCH_INTERNAL_CONFIG_VARIADIC_MACROS + +#endif + +// Use __COUNTER__ if the compiler supports it +#if ( defined _MSC_VER && _MSC_VER >= 1300 ) || \ + ( defined __GNUC__ && __GNUC__ >= 4 && __GNUC_MINOR__ >= 3 ) || \ + ( defined __clang__ && __clang_major__ >= 3 ) + +#define CATCH_INTERNAL_CONFIG_COUNTER + +#endif + +//////////////////////////////////////////////////////////////////////////////// +// C++ language feature support + +// catch all support for C++11 +#if defined(CATCH_CPP11_OR_GREATER) + +# if !defined(CATCH_INTERNAL_CONFIG_CPP11_NULLPTR) +# define CATCH_INTERNAL_CONFIG_CPP11_NULLPTR +# endif + +# ifndef CATCH_INTERNAL_CONFIG_CPP11_NOEXCEPT +# define CATCH_INTERNAL_CONFIG_CPP11_NOEXCEPT +# endif + +# ifndef CATCH_INTERNAL_CONFIG_CPP11_GENERATED_METHODS +# define CATCH_INTERNAL_CONFIG_CPP11_GENERATED_METHODS +# endif + +# ifndef CATCH_INTERNAL_CONFIG_CPP11_IS_ENUM +# define CATCH_INTERNAL_CONFIG_CPP11_IS_ENUM +# endif + +# ifndef CATCH_INTERNAL_CONFIG_CPP11_TUPLE +# define CATCH_INTERNAL_CONFIG_CPP11_TUPLE +# endif + +# ifndef CATCH_INTERNAL_CONFIG_VARIADIC_MACROS +# define CATCH_INTERNAL_CONFIG_VARIADIC_MACROS +# endif + +# if !defined(CATCH_INTERNAL_CONFIG_CPP11_LONG_LONG) +# define CATCH_INTERNAL_CONFIG_CPP11_LONG_LONG +# endif + +# if !defined(CATCH_INTERNAL_CONFIG_CPP11_OVERRIDE) +# define CATCH_INTERNAL_CONFIG_CPP11_OVERRIDE +# endif +# if !defined(CATCH_INTERNAL_CONFIG_CPP11_UNIQUE_PTR) +# define CATCH_INTERNAL_CONFIG_CPP11_UNIQUE_PTR +# endif + +#endif // __cplusplus >= 201103L + +// Now set the actual defines based on the above + anything the user has configured +#if defined(CATCH_INTERNAL_CONFIG_CPP11_NULLPTR) && !defined(CATCH_CONFIG_CPP11_NO_NULLPTR) && !defined(CATCH_CONFIG_CPP11_NULLPTR) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_NULLPTR +#endif +#if defined(CATCH_INTERNAL_CONFIG_CPP11_NOEXCEPT) && !defined(CATCH_CONFIG_CPP11_NO_NOEXCEPT) && !defined(CATCH_CONFIG_CPP11_NOEXCEPT) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_NOEXCEPT +#endif +#if defined(CATCH_INTERNAL_CONFIG_CPP11_GENERATED_METHODS) && !defined(CATCH_CONFIG_CPP11_NO_GENERATED_METHODS) && !defined(CATCH_CONFIG_CPP11_GENERATED_METHODS) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_GENERATED_METHODS +#endif +#if defined(CATCH_INTERNAL_CONFIG_CPP11_IS_ENUM) && !defined(CATCH_CONFIG_CPP11_NO_IS_ENUM) && !defined(CATCH_CONFIG_CPP11_IS_ENUM) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_IS_ENUM +#endif +#if defined(CATCH_INTERNAL_CONFIG_CPP11_TUPLE) && !defined(CATCH_CONFIG_CPP11_NO_TUPLE) && !defined(CATCH_CONFIG_CPP11_TUPLE) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_TUPLE +#endif +#if defined(CATCH_INTERNAL_CONFIG_VARIADIC_MACROS) && !defined(CATCH_CONFIG_NO_VARIADIC_MACROS) && !defined(CATCH_CONFIG_VARIADIC_MACROS) +# define CATCH_CONFIG_VARIADIC_MACROS +#endif +#if defined(CATCH_INTERNAL_CONFIG_CPP11_LONG_LONG) && !defined(CATCH_CONFIG_NO_LONG_LONG) && !defined(CATCH_CONFIG_CPP11_LONG_LONG) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_LONG_LONG +#endif +#if defined(CATCH_INTERNAL_CONFIG_CPP11_OVERRIDE) && !defined(CATCH_CONFIG_NO_OVERRIDE) && !defined(CATCH_CONFIG_CPP11_OVERRIDE) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_OVERRIDE +#endif +#if defined(CATCH_INTERNAL_CONFIG_CPP11_UNIQUE_PTR) && !defined(CATCH_CONFIG_NO_UNIQUE_PTR) && !defined(CATCH_CONFIG_CPP11_UNIQUE_PTR) && !defined(CATCH_CONFIG_NO_CPP11) +# define CATCH_CONFIG_CPP11_UNIQUE_PTR +#endif +#if defined(CATCH_INTERNAL_CONFIG_COUNTER) && !defined(CATCH_CONFIG_NO_COUNTER) && !defined(CATCH_CONFIG_COUNTER) +# define CATCH_CONFIG_COUNTER +#endif + +#if !defined(CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS) +# define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS +#endif + +// noexcept support: +#if defined(CATCH_CONFIG_CPP11_NOEXCEPT) && !defined(CATCH_NOEXCEPT) +# define CATCH_NOEXCEPT noexcept +# define CATCH_NOEXCEPT_IS(x) noexcept(x) +#else +# define CATCH_NOEXCEPT throw() +# define CATCH_NOEXCEPT_IS(x) +#endif + +// nullptr support +#ifdef CATCH_CONFIG_CPP11_NULLPTR +# define CATCH_NULL nullptr +#else +# define CATCH_NULL NULL +#endif + +// override support +#ifdef CATCH_CONFIG_CPP11_OVERRIDE +# define CATCH_OVERRIDE override +#else +# define CATCH_OVERRIDE +#endif + +// unique_ptr support +#ifdef CATCH_CONFIG_CPP11_UNIQUE_PTR +# define CATCH_AUTO_PTR( T ) std::unique_ptr +#else +# define CATCH_AUTO_PTR( T ) std::auto_ptr +#endif + +namespace Catch { + + struct IConfig; + + struct CaseSensitive { enum Choice { + Yes, + No + }; }; + + class NonCopyable { +#ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + NonCopyable( NonCopyable const& ) = delete; + NonCopyable( NonCopyable && ) = delete; + NonCopyable& operator = ( NonCopyable const& ) = delete; + NonCopyable& operator = ( NonCopyable && ) = delete; +#else + NonCopyable( NonCopyable const& info ); + NonCopyable& operator = ( NonCopyable const& ); +#endif + + protected: + NonCopyable() {} + virtual ~NonCopyable(); + }; + + class SafeBool { + public: + typedef void (SafeBool::*type)() const; + + static type makeSafe( bool value ) { + return value ? &SafeBool::trueValue : 0; + } + private: + void trueValue() const {} + }; + + template + inline void deleteAll( ContainerT& container ) { + typename ContainerT::const_iterator it = container.begin(); + typename ContainerT::const_iterator itEnd = container.end(); + for(; it != itEnd; ++it ) + delete *it; + } + template + inline void deleteAllValues( AssociativeContainerT& container ) { + typename AssociativeContainerT::const_iterator it = container.begin(); + typename AssociativeContainerT::const_iterator itEnd = container.end(); + for(; it != itEnd; ++it ) + delete it->second; + } + + bool startsWith( std::string const& s, std::string const& prefix ); + bool endsWith( std::string const& s, std::string const& suffix ); + bool contains( std::string const& s, std::string const& infix ); + void toLowerInPlace( std::string& s ); + std::string toLower( std::string const& s ); + std::string trim( std::string const& str ); + bool replaceInPlace( std::string& str, std::string const& replaceThis, std::string const& withThis ); + + struct pluralise { + pluralise( std::size_t count, std::string const& label ); + + friend std::ostream& operator << ( std::ostream& os, pluralise const& pluraliser ); + + std::size_t m_count; + std::string m_label; + }; + + struct SourceLineInfo { + + SourceLineInfo(); + SourceLineInfo( char const* _file, std::size_t _line ); + SourceLineInfo( SourceLineInfo const& other ); +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + SourceLineInfo( SourceLineInfo && ) = default; + SourceLineInfo& operator = ( SourceLineInfo const& ) = default; + SourceLineInfo& operator = ( SourceLineInfo && ) = default; +# endif + bool empty() const; + bool operator == ( SourceLineInfo const& other ) const; + bool operator < ( SourceLineInfo const& other ) const; + + std::string file; + std::size_t line; + }; + + std::ostream& operator << ( std::ostream& os, SourceLineInfo const& info ); + + // This is just here to avoid compiler warnings with macro constants and boolean literals + inline bool isTrue( bool value ){ return value; } + inline bool alwaysTrue() { return true; } + inline bool alwaysFalse() { return false; } + + void throwLogicError( std::string const& message, SourceLineInfo const& locationInfo ); + + void seedRng( IConfig const& config ); + unsigned int rngSeed(); + + // Use this in variadic streaming macros to allow + // >> +StreamEndStop + // as well as + // >> stuff +StreamEndStop + struct StreamEndStop { + std::string operator+() { + return std::string(); + } + }; + template + T const& operator + ( T const& value, StreamEndStop ) { + return value; + } +} + +#define CATCH_INTERNAL_LINEINFO ::Catch::SourceLineInfo( __FILE__, static_cast( __LINE__ ) ) +#define CATCH_INTERNAL_ERROR( msg ) ::Catch::throwLogicError( msg, CATCH_INTERNAL_LINEINFO ); + +#include + +namespace Catch { + + class NotImplementedException : public std::exception + { + public: + NotImplementedException( SourceLineInfo const& lineInfo ); + NotImplementedException( NotImplementedException const& ) {} + + virtual ~NotImplementedException() CATCH_NOEXCEPT {} + + virtual const char* what() const CATCH_NOEXCEPT; + + private: + std::string m_what; + SourceLineInfo m_lineInfo; + }; + +} // end namespace Catch + +/////////////////////////////////////////////////////////////////////////////// +#define CATCH_NOT_IMPLEMENTED throw Catch::NotImplementedException( CATCH_INTERNAL_LINEINFO ) + +// #included from: internal/catch_context.h +#define TWOBLUECUBES_CATCH_CONTEXT_H_INCLUDED + +// #included from: catch_interfaces_generators.h +#define TWOBLUECUBES_CATCH_INTERFACES_GENERATORS_H_INCLUDED + +#include + +namespace Catch { + + struct IGeneratorInfo { + virtual ~IGeneratorInfo(); + virtual bool moveNext() = 0; + virtual std::size_t getCurrentIndex() const = 0; + }; + + struct IGeneratorsForTest { + virtual ~IGeneratorsForTest(); + + virtual IGeneratorInfo& getGeneratorInfo( std::string const& fileInfo, std::size_t size ) = 0; + virtual bool moveNext() = 0; + }; + + IGeneratorsForTest* createGeneratorsForTest(); + +} // end namespace Catch + +// #included from: catch_ptr.hpp +#define TWOBLUECUBES_CATCH_PTR_HPP_INCLUDED + +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wpadded" +#endif + +namespace Catch { + + // An intrusive reference counting smart pointer. + // T must implement addRef() and release() methods + // typically implementing the IShared interface + template + class Ptr { + public: + Ptr() : m_p( CATCH_NULL ){} + Ptr( T* p ) : m_p( p ){ + if( m_p ) + m_p->addRef(); + } + Ptr( Ptr const& other ) : m_p( other.m_p ){ + if( m_p ) + m_p->addRef(); + } + ~Ptr(){ + if( m_p ) + m_p->release(); + } + void reset() { + if( m_p ) + m_p->release(); + m_p = CATCH_NULL; + } + Ptr& operator = ( T* p ){ + Ptr temp( p ); + swap( temp ); + return *this; + } + Ptr& operator = ( Ptr const& other ){ + Ptr temp( other ); + swap( temp ); + return *this; + } + void swap( Ptr& other ) { std::swap( m_p, other.m_p ); } + T* get() const{ return m_p; } + T& operator*() const { return *m_p; } + T* operator->() const { return m_p; } + bool operator !() const { return m_p == CATCH_NULL; } + operator SafeBool::type() const { return SafeBool::makeSafe( m_p != CATCH_NULL ); } + + private: + T* m_p; + }; + + struct IShared : NonCopyable { + virtual ~IShared(); + virtual void addRef() const = 0; + virtual void release() const = 0; + }; + + template + struct SharedImpl : T { + + SharedImpl() : m_rc( 0 ){} + + virtual void addRef() const { + ++m_rc; + } + virtual void release() const { + if( --m_rc == 0 ) + delete this; + } + + mutable unsigned int m_rc; + }; + +} // end namespace Catch + +#ifdef __clang__ +#pragma clang diagnostic pop +#endif + +#include +#include +#include + +namespace Catch { + + class TestCase; + class Stream; + struct IResultCapture; + struct IRunner; + struct IGeneratorsForTest; + struct IConfig; + + struct IContext + { + virtual ~IContext(); + + virtual IResultCapture* getResultCapture() = 0; + virtual IRunner* getRunner() = 0; + virtual size_t getGeneratorIndex( std::string const& fileInfo, size_t totalSize ) = 0; + virtual bool advanceGeneratorsForCurrentTest() = 0; + virtual Ptr getConfig() const = 0; + }; + + struct IMutableContext : IContext + { + virtual ~IMutableContext(); + virtual void setResultCapture( IResultCapture* resultCapture ) = 0; + virtual void setRunner( IRunner* runner ) = 0; + virtual void setConfig( Ptr const& config ) = 0; + }; + + IContext& getCurrentContext(); + IMutableContext& getCurrentMutableContext(); + void cleanUpContext(); + Stream createStream( std::string const& streamName ); + +} + +// #included from: internal/catch_test_registry.hpp +#define TWOBLUECUBES_CATCH_TEST_REGISTRY_HPP_INCLUDED + +// #included from: catch_interfaces_testcase.h +#define TWOBLUECUBES_CATCH_INTERFACES_TESTCASE_H_INCLUDED + +#include + +namespace Catch { + + class TestSpec; + + struct ITestCase : IShared { + virtual void invoke () const = 0; + protected: + virtual ~ITestCase(); + }; + + class TestCase; + struct IConfig; + + struct ITestCaseRegistry { + virtual ~ITestCaseRegistry(); + virtual std::vector const& getAllTests() const = 0; + virtual std::vector const& getAllTestsSorted( IConfig const& config ) const = 0; + }; + + bool matchTest( TestCase const& testCase, TestSpec const& testSpec, IConfig const& config ); + std::vector filterTests( std::vector const& testCases, TestSpec const& testSpec, IConfig const& config ); + std::vector const& getAllTestCasesSorted( IConfig const& config ); + +} + +namespace Catch { + +template +class MethodTestCase : public SharedImpl { + +public: + MethodTestCase( void (C::*method)() ) : m_method( method ) {} + + virtual void invoke() const { + C obj; + (obj.*m_method)(); + } + +private: + virtual ~MethodTestCase() {} + + void (C::*m_method)(); +}; + +typedef void(*TestFunction)(); + +struct NameAndDesc { + NameAndDesc( const char* _name = "", const char* _description= "" ) + : name( _name ), description( _description ) + {} + + const char* name; + const char* description; +}; + +void registerTestCase + ( ITestCase* testCase, + char const* className, + NameAndDesc const& nameAndDesc, + SourceLineInfo const& lineInfo ); + +struct AutoReg { + + AutoReg + ( TestFunction function, + SourceLineInfo const& lineInfo, + NameAndDesc const& nameAndDesc ); + + template + AutoReg + ( void (C::*method)(), + char const* className, + NameAndDesc const& nameAndDesc, + SourceLineInfo const& lineInfo ) { + + registerTestCase + ( new MethodTestCase( method ), + className, + nameAndDesc, + lineInfo ); + } + + ~AutoReg(); + +private: + AutoReg( AutoReg const& ); + void operator= ( AutoReg const& ); +}; + +void registerTestCaseFunction + ( TestFunction function, + SourceLineInfo const& lineInfo, + NameAndDesc const& nameAndDesc ); + +} // end namespace Catch + +#ifdef CATCH_CONFIG_VARIADIC_MACROS + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_TESTCASE2( TestName, ... ) \ + static void TestName(); \ + namespace{ Catch::AutoReg INTERNAL_CATCH_UNIQUE_NAME( autoRegistrar )( &TestName, CATCH_INTERNAL_LINEINFO, Catch::NameAndDesc( __VA_ARGS__ ) ); }\ + static void TestName() + #define INTERNAL_CATCH_TESTCASE( ... ) \ + INTERNAL_CATCH_TESTCASE2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), __VA_ARGS__ ) + + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_METHOD_AS_TEST_CASE( QualifiedMethod, ... ) \ + namespace{ Catch::AutoReg INTERNAL_CATCH_UNIQUE_NAME( autoRegistrar )( &QualifiedMethod, "&" #QualifiedMethod, Catch::NameAndDesc( __VA_ARGS__ ), CATCH_INTERNAL_LINEINFO ); } + + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_TEST_CASE_METHOD2( TestName, ClassName, ... )\ + namespace{ \ + struct TestName : ClassName{ \ + void test(); \ + }; \ + Catch::AutoReg INTERNAL_CATCH_UNIQUE_NAME( autoRegistrar ) ( &TestName::test, #ClassName, Catch::NameAndDesc( __VA_ARGS__ ), CATCH_INTERNAL_LINEINFO ); \ + } \ + void TestName::test() + #define INTERNAL_CATCH_TEST_CASE_METHOD( ClassName, ... ) \ + INTERNAL_CATCH_TEST_CASE_METHOD2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), ClassName, __VA_ARGS__ ) + + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_REGISTER_TESTCASE( Function, ... ) \ + Catch::AutoReg( Function, CATCH_INTERNAL_LINEINFO, Catch::NameAndDesc( __VA_ARGS__ ) ); + +#else + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_TESTCASE2( TestName, Name, Desc ) \ + static void TestName(); \ + namespace{ Catch::AutoReg INTERNAL_CATCH_UNIQUE_NAME( autoRegistrar )( &TestName, CATCH_INTERNAL_LINEINFO, Catch::NameAndDesc( Name, Desc ) ); }\ + static void TestName() + #define INTERNAL_CATCH_TESTCASE( Name, Desc ) \ + INTERNAL_CATCH_TESTCASE2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), Name, Desc ) + + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_METHOD_AS_TEST_CASE( QualifiedMethod, Name, Desc ) \ + namespace{ Catch::AutoReg INTERNAL_CATCH_UNIQUE_NAME( autoRegistrar )( &QualifiedMethod, "&" #QualifiedMethod, Catch::NameAndDesc( Name, Desc ), CATCH_INTERNAL_LINEINFO ); } + + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_TEST_CASE_METHOD2( TestCaseName, ClassName, TestName, Desc )\ + namespace{ \ + struct TestCaseName : ClassName{ \ + void test(); \ + }; \ + Catch::AutoReg INTERNAL_CATCH_UNIQUE_NAME( autoRegistrar ) ( &TestCaseName::test, #ClassName, Catch::NameAndDesc( TestName, Desc ), CATCH_INTERNAL_LINEINFO ); \ + } \ + void TestCaseName::test() + #define INTERNAL_CATCH_TEST_CASE_METHOD( ClassName, TestName, Desc )\ + INTERNAL_CATCH_TEST_CASE_METHOD2( INTERNAL_CATCH_UNIQUE_NAME( ____C_A_T_C_H____T_E_S_T____ ), ClassName, TestName, Desc ) + + /////////////////////////////////////////////////////////////////////////////// + #define INTERNAL_CATCH_REGISTER_TESTCASE( Function, Name, Desc ) \ + Catch::AutoReg( Function, CATCH_INTERNAL_LINEINFO, Catch::NameAndDesc( Name, Desc ) ); +#endif + +// #included from: internal/catch_capture.hpp +#define TWOBLUECUBES_CATCH_CAPTURE_HPP_INCLUDED + +// #included from: catch_result_builder.h +#define TWOBLUECUBES_CATCH_RESULT_BUILDER_H_INCLUDED + +// #included from: catch_result_type.h +#define TWOBLUECUBES_CATCH_RESULT_TYPE_H_INCLUDED + +namespace Catch { + + // ResultWas::OfType enum + struct ResultWas { enum OfType { + Unknown = -1, + Ok = 0, + Info = 1, + Warning = 2, + + FailureBit = 0x10, + + ExpressionFailed = FailureBit | 1, + ExplicitFailure = FailureBit | 2, + + Exception = 0x100 | FailureBit, + + ThrewException = Exception | 1, + DidntThrowException = Exception | 2, + + FatalErrorCondition = 0x200 | FailureBit + + }; }; + + inline bool isOk( ResultWas::OfType resultType ) { + return ( resultType & ResultWas::FailureBit ) == 0; + } + inline bool isJustInfo( int flags ) { + return flags == ResultWas::Info; + } + + // ResultDisposition::Flags enum + struct ResultDisposition { enum Flags { + Normal = 0x01, + + ContinueOnFailure = 0x02, // Failures fail test, but execution continues + FalseTest = 0x04, // Prefix expression with ! + SuppressFail = 0x08 // Failures are reported but do not fail the test + }; }; + + inline ResultDisposition::Flags operator | ( ResultDisposition::Flags lhs, ResultDisposition::Flags rhs ) { + return static_cast( static_cast( lhs ) | static_cast( rhs ) ); + } + + inline bool shouldContinueOnFailure( int flags ) { return ( flags & ResultDisposition::ContinueOnFailure ) != 0; } + inline bool isFalseTest( int flags ) { return ( flags & ResultDisposition::FalseTest ) != 0; } + inline bool shouldSuppressFailure( int flags ) { return ( flags & ResultDisposition::SuppressFail ) != 0; } + +} // end namespace Catch + +// #included from: catch_assertionresult.h +#define TWOBLUECUBES_CATCH_ASSERTIONRESULT_H_INCLUDED + +#include + +namespace Catch { + + struct AssertionInfo + { + AssertionInfo() {} + AssertionInfo( std::string const& _macroName, + SourceLineInfo const& _lineInfo, + std::string const& _capturedExpression, + ResultDisposition::Flags _resultDisposition ); + + std::string macroName; + SourceLineInfo lineInfo; + std::string capturedExpression; + ResultDisposition::Flags resultDisposition; + }; + + struct AssertionResultData + { + AssertionResultData() : resultType( ResultWas::Unknown ) {} + + std::string reconstructedExpression; + std::string message; + ResultWas::OfType resultType; + }; + + class AssertionResult { + public: + AssertionResult(); + AssertionResult( AssertionInfo const& info, AssertionResultData const& data ); + ~AssertionResult(); +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + AssertionResult( AssertionResult const& ) = default; + AssertionResult( AssertionResult && ) = default; + AssertionResult& operator = ( AssertionResult const& ) = default; + AssertionResult& operator = ( AssertionResult && ) = default; +# endif + + bool isOk() const; + bool succeeded() const; + ResultWas::OfType getResultType() const; + bool hasExpression() const; + bool hasMessage() const; + std::string getExpression() const; + std::string getExpressionInMacro() const; + bool hasExpandedExpression() const; + std::string getExpandedExpression() const; + std::string getMessage() const; + SourceLineInfo getSourceInfo() const; + std::string getTestMacroName() const; + + protected: + AssertionInfo m_info; + AssertionResultData m_resultData; + }; + +} // end namespace Catch + +// #included from: catch_matchers.hpp +#define TWOBLUECUBES_CATCH_MATCHERS_HPP_INCLUDED + +namespace Catch { +namespace Matchers { + namespace Impl { + + namespace Generic { + template class AllOf; + template class AnyOf; + template class Not; + } + + template + struct Matcher : SharedImpl + { + typedef ExpressionT ExpressionType; + + virtual ~Matcher() {} + virtual Ptr clone() const = 0; + virtual bool match( ExpressionT const& expr ) const = 0; + virtual std::string toString() const = 0; + + Generic::AllOf operator && ( Matcher const& other ) const; + Generic::AnyOf operator || ( Matcher const& other ) const; + Generic::Not operator ! () const; + }; + + template + struct MatcherImpl : Matcher { + + virtual Ptr > clone() const { + return Ptr >( new DerivedT( static_cast( *this ) ) ); + } + }; + + namespace Generic { + template + class Not : public MatcherImpl, ExpressionT> { + public: + explicit Not( Matcher const& matcher ) : m_matcher(matcher.clone()) {} + Not( Not const& other ) : m_matcher( other.m_matcher ) {} + + virtual bool match( ExpressionT const& expr ) const CATCH_OVERRIDE { + return !m_matcher->match( expr ); + } + + virtual std::string toString() const CATCH_OVERRIDE { + return "not " + m_matcher->toString(); + } + private: + Ptr< Matcher > m_matcher; + }; + + template + class AllOf : public MatcherImpl, ExpressionT> { + public: + + AllOf() {} + AllOf( AllOf const& other ) : m_matchers( other.m_matchers ) {} + + AllOf& add( Matcher const& matcher ) { + m_matchers.push_back( matcher.clone() ); + return *this; + } + virtual bool match( ExpressionT const& expr ) const + { + for( std::size_t i = 0; i < m_matchers.size(); ++i ) + if( !m_matchers[i]->match( expr ) ) + return false; + return true; + } + virtual std::string toString() const { + std::ostringstream oss; + oss << "( "; + for( std::size_t i = 0; i < m_matchers.size(); ++i ) { + if( i != 0 ) + oss << " and "; + oss << m_matchers[i]->toString(); + } + oss << " )"; + return oss.str(); + } + + AllOf operator && ( Matcher const& other ) const { + AllOf allOfExpr( *this ); + allOfExpr.add( other ); + return allOfExpr; + } + + private: + std::vector > > m_matchers; + }; + + template + class AnyOf : public MatcherImpl, ExpressionT> { + public: + + AnyOf() {} + AnyOf( AnyOf const& other ) : m_matchers( other.m_matchers ) {} + + AnyOf& add( Matcher const& matcher ) { + m_matchers.push_back( matcher.clone() ); + return *this; + } + virtual bool match( ExpressionT const& expr ) const + { + for( std::size_t i = 0; i < m_matchers.size(); ++i ) + if( m_matchers[i]->match( expr ) ) + return true; + return false; + } + virtual std::string toString() const { + std::ostringstream oss; + oss << "( "; + for( std::size_t i = 0; i < m_matchers.size(); ++i ) { + if( i != 0 ) + oss << " or "; + oss << m_matchers[i]->toString(); + } + oss << " )"; + return oss.str(); + } + + AnyOf operator || ( Matcher const& other ) const { + AnyOf anyOfExpr( *this ); + anyOfExpr.add( other ); + return anyOfExpr; + } + + private: + std::vector > > m_matchers; + }; + + } // namespace Generic + + template + Generic::AllOf Matcher::operator && ( Matcher const& other ) const { + Generic::AllOf allOfExpr; + allOfExpr.add( *this ); + allOfExpr.add( other ); + return allOfExpr; + } + + template + Generic::AnyOf Matcher::operator || ( Matcher const& other ) const { + Generic::AnyOf anyOfExpr; + anyOfExpr.add( *this ); + anyOfExpr.add( other ); + return anyOfExpr; + } + + template + Generic::Not Matcher::operator ! () const { + return Generic::Not( *this ); + } + + namespace StdString { + + inline std::string makeString( std::string const& str ) { return str; } + inline std::string makeString( const char* str ) { return str ? std::string( str ) : std::string(); } + + struct CasedString + { + CasedString( std::string const& str, CaseSensitive::Choice caseSensitivity ) + : m_caseSensitivity( caseSensitivity ), + m_str( adjustString( str ) ) + {} + std::string adjustString( std::string const& str ) const { + return m_caseSensitivity == CaseSensitive::No + ? toLower( str ) + : str; + + } + std::string toStringSuffix() const + { + return m_caseSensitivity == CaseSensitive::No + ? " (case insensitive)" + : ""; + } + CaseSensitive::Choice m_caseSensitivity; + std::string m_str; + }; + + struct Equals : MatcherImpl { + Equals( std::string const& str, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) + : m_data( str, caseSensitivity ) + {} + Equals( Equals const& other ) : m_data( other.m_data ){} + + virtual ~Equals(); + + virtual bool match( std::string const& expr ) const { + return m_data.m_str == m_data.adjustString( expr );; + } + virtual std::string toString() const { + return "equals: \"" + m_data.m_str + "\"" + m_data.toStringSuffix(); + } + + CasedString m_data; + }; + + struct Contains : MatcherImpl { + Contains( std::string const& substr, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) + : m_data( substr, caseSensitivity ){} + Contains( Contains const& other ) : m_data( other.m_data ){} + + virtual ~Contains(); + + virtual bool match( std::string const& expr ) const { + return m_data.adjustString( expr ).find( m_data.m_str ) != std::string::npos; + } + virtual std::string toString() const { + return "contains: \"" + m_data.m_str + "\"" + m_data.toStringSuffix(); + } + + CasedString m_data; + }; + + struct StartsWith : MatcherImpl { + StartsWith( std::string const& substr, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) + : m_data( substr, caseSensitivity ){} + + StartsWith( StartsWith const& other ) : m_data( other.m_data ){} + + virtual ~StartsWith(); + + virtual bool match( std::string const& expr ) const { + return startsWith( m_data.adjustString( expr ), m_data.m_str ); + } + virtual std::string toString() const { + return "starts with: \"" + m_data.m_str + "\"" + m_data.toStringSuffix(); + } + + CasedString m_data; + }; + + struct EndsWith : MatcherImpl { + EndsWith( std::string const& substr, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) + : m_data( substr, caseSensitivity ){} + EndsWith( EndsWith const& other ) : m_data( other.m_data ){} + + virtual ~EndsWith(); + + virtual bool match( std::string const& expr ) const { + return endsWith( m_data.adjustString( expr ), m_data.m_str ); + } + virtual std::string toString() const { + return "ends with: \"" + m_data.m_str + "\"" + m_data.toStringSuffix(); + } + + CasedString m_data; + }; + } // namespace StdString + } // namespace Impl + + // The following functions create the actual matcher objects. + // This allows the types to be inferred + template + inline Impl::Generic::Not Not( Impl::Matcher const& m ) { + return Impl::Generic::Not( m ); + } + + template + inline Impl::Generic::AllOf AllOf( Impl::Matcher const& m1, + Impl::Matcher const& m2 ) { + return Impl::Generic::AllOf().add( m1 ).add( m2 ); + } + template + inline Impl::Generic::AllOf AllOf( Impl::Matcher const& m1, + Impl::Matcher const& m2, + Impl::Matcher const& m3 ) { + return Impl::Generic::AllOf().add( m1 ).add( m2 ).add( m3 ); + } + template + inline Impl::Generic::AnyOf AnyOf( Impl::Matcher const& m1, + Impl::Matcher const& m2 ) { + return Impl::Generic::AnyOf().add( m1 ).add( m2 ); + } + template + inline Impl::Generic::AnyOf AnyOf( Impl::Matcher const& m1, + Impl::Matcher const& m2, + Impl::Matcher const& m3 ) { + return Impl::Generic::AnyOf().add( m1 ).add( m2 ).add( m3 ); + } + + inline Impl::StdString::Equals Equals( std::string const& str, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) { + return Impl::StdString::Equals( str, caseSensitivity ); + } + inline Impl::StdString::Equals Equals( const char* str, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) { + return Impl::StdString::Equals( Impl::StdString::makeString( str ), caseSensitivity ); + } + inline Impl::StdString::Contains Contains( std::string const& substr, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) { + return Impl::StdString::Contains( substr, caseSensitivity ); + } + inline Impl::StdString::Contains Contains( const char* substr, CaseSensitive::Choice caseSensitivity = CaseSensitive::Yes ) { + return Impl::StdString::Contains( Impl::StdString::makeString( substr ), caseSensitivity ); + } + inline Impl::StdString::StartsWith StartsWith( std::string const& substr ) { + return Impl::StdString::StartsWith( substr ); + } + inline Impl::StdString::StartsWith StartsWith( const char* substr ) { + return Impl::StdString::StartsWith( Impl::StdString::makeString( substr ) ); + } + inline Impl::StdString::EndsWith EndsWith( std::string const& substr ) { + return Impl::StdString::EndsWith( substr ); + } + inline Impl::StdString::EndsWith EndsWith( const char* substr ) { + return Impl::StdString::EndsWith( Impl::StdString::makeString( substr ) ); + } + +} // namespace Matchers + +using namespace Matchers; + +} // namespace Catch + +namespace Catch { + + struct TestFailureException{}; + + template class ExpressionLhs; + + struct STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison; + + struct CopyableStream { + CopyableStream() {} + CopyableStream( CopyableStream const& other ) { + oss << other.oss.str(); + } + CopyableStream& operator=( CopyableStream const& other ) { + oss.str(""); + oss << other.oss.str(); + return *this; + } + std::ostringstream oss; + }; + + class ResultBuilder { + public: + ResultBuilder( char const* macroName, + SourceLineInfo const& lineInfo, + char const* capturedExpression, + ResultDisposition::Flags resultDisposition, + char const* secondArg = "" ); + + template + ExpressionLhs operator <= ( T const& operand ); + ExpressionLhs operator <= ( bool value ); + + template + ResultBuilder& operator << ( T const& value ) { + m_stream.oss << value; + return *this; + } + + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator && ( RhsT const& ); + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator || ( RhsT const& ); + + ResultBuilder& setResultType( ResultWas::OfType result ); + ResultBuilder& setResultType( bool result ); + ResultBuilder& setLhs( std::string const& lhs ); + ResultBuilder& setRhs( std::string const& rhs ); + ResultBuilder& setOp( std::string const& op ); + + void endExpression(); + + std::string reconstructExpression() const; + AssertionResult build() const; + + void useActiveException( ResultDisposition::Flags resultDisposition = ResultDisposition::Normal ); + void captureResult( ResultWas::OfType resultType ); + void captureExpression(); + void captureExpectedException( std::string const& expectedMessage ); + void captureExpectedException( Matchers::Impl::Matcher const& matcher ); + void handleResult( AssertionResult const& result ); + void react(); + bool shouldDebugBreak() const; + bool allowThrows() const; + + private: + AssertionInfo m_assertionInfo; + AssertionResultData m_data; + struct ExprComponents { + ExprComponents() : testFalse( false ) {} + bool testFalse; + std::string lhs, rhs, op; + } m_exprComponents; + CopyableStream m_stream; + + bool m_shouldDebugBreak; + bool m_shouldThrow; + }; + +} // namespace Catch + +// Include after due to circular dependency: +// #included from: catch_expression_lhs.hpp +#define TWOBLUECUBES_CATCH_EXPRESSION_LHS_HPP_INCLUDED + +// #included from: catch_evaluate.hpp +#define TWOBLUECUBES_CATCH_EVALUATE_HPP_INCLUDED + +#ifdef _MSC_VER +#pragma warning(push) +#pragma warning(disable:4389) // '==' : signed/unsigned mismatch +#endif + +#include + +namespace Catch { +namespace Internal { + + enum Operator { + IsEqualTo, + IsNotEqualTo, + IsLessThan, + IsGreaterThan, + IsLessThanOrEqualTo, + IsGreaterThanOrEqualTo + }; + + template struct OperatorTraits { static const char* getName(){ return "*error*"; } }; + template<> struct OperatorTraits { static const char* getName(){ return "=="; } }; + template<> struct OperatorTraits { static const char* getName(){ return "!="; } }; + template<> struct OperatorTraits { static const char* getName(){ return "<"; } }; + template<> struct OperatorTraits { static const char* getName(){ return ">"; } }; + template<> struct OperatorTraits { static const char* getName(){ return "<="; } }; + template<> struct OperatorTraits{ static const char* getName(){ return ">="; } }; + + template + inline T& opCast(T const& t) { return const_cast(t); } + +// nullptr_t support based on pull request #154 from Konstantin Baumann +#ifdef CATCH_CONFIG_CPP11_NULLPTR + inline std::nullptr_t opCast(std::nullptr_t) { return nullptr; } +#endif // CATCH_CONFIG_CPP11_NULLPTR + + // So the compare overloads can be operator agnostic we convey the operator as a template + // enum, which is used to specialise an Evaluator for doing the comparison. + template + class Evaluator{}; + + template + struct Evaluator { + static bool evaluate( T1 const& lhs, T2 const& rhs) { + return bool( opCast( lhs ) == opCast( rhs ) ); + } + }; + template + struct Evaluator { + static bool evaluate( T1 const& lhs, T2 const& rhs ) { + return bool( opCast( lhs ) != opCast( rhs ) ); + } + }; + template + struct Evaluator { + static bool evaluate( T1 const& lhs, T2 const& rhs ) { + return bool( opCast( lhs ) < opCast( rhs ) ); + } + }; + template + struct Evaluator { + static bool evaluate( T1 const& lhs, T2 const& rhs ) { + return bool( opCast( lhs ) > opCast( rhs ) ); + } + }; + template + struct Evaluator { + static bool evaluate( T1 const& lhs, T2 const& rhs ) { + return bool( opCast( lhs ) >= opCast( rhs ) ); + } + }; + template + struct Evaluator { + static bool evaluate( T1 const& lhs, T2 const& rhs ) { + return bool( opCast( lhs ) <= opCast( rhs ) ); + } + }; + + template + bool applyEvaluator( T1 const& lhs, T2 const& rhs ) { + return Evaluator::evaluate( lhs, rhs ); + } + + // This level of indirection allows us to specialise for integer types + // to avoid signed/ unsigned warnings + + // "base" overload + template + bool compare( T1 const& lhs, T2 const& rhs ) { + return Evaluator::evaluate( lhs, rhs ); + } + + // unsigned X to int + template bool compare( unsigned int lhs, int rhs ) { + return applyEvaluator( lhs, static_cast( rhs ) ); + } + template bool compare( unsigned long lhs, int rhs ) { + return applyEvaluator( lhs, static_cast( rhs ) ); + } + template bool compare( unsigned char lhs, int rhs ) { + return applyEvaluator( lhs, static_cast( rhs ) ); + } + + // unsigned X to long + template bool compare( unsigned int lhs, long rhs ) { + return applyEvaluator( lhs, static_cast( rhs ) ); + } + template bool compare( unsigned long lhs, long rhs ) { + return applyEvaluator( lhs, static_cast( rhs ) ); + } + template bool compare( unsigned char lhs, long rhs ) { + return applyEvaluator( lhs, static_cast( rhs ) ); + } + + // int to unsigned X + template bool compare( int lhs, unsigned int rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( int lhs, unsigned long rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( int lhs, unsigned char rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + + // long to unsigned X + template bool compare( long lhs, unsigned int rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( long lhs, unsigned long rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( long lhs, unsigned char rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + + // pointer to long (when comparing against NULL) + template bool compare( long lhs, T* rhs ) { + return Evaluator::evaluate( reinterpret_cast( lhs ), rhs ); + } + template bool compare( T* lhs, long rhs ) { + return Evaluator::evaluate( lhs, reinterpret_cast( rhs ) ); + } + + // pointer to int (when comparing against NULL) + template bool compare( int lhs, T* rhs ) { + return Evaluator::evaluate( reinterpret_cast( lhs ), rhs ); + } + template bool compare( T* lhs, int rhs ) { + return Evaluator::evaluate( lhs, reinterpret_cast( rhs ) ); + } + +#ifdef CATCH_CONFIG_CPP11_LONG_LONG + // long long to unsigned X + template bool compare( long long lhs, unsigned int rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( long long lhs, unsigned long rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( long long lhs, unsigned long long rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( long long lhs, unsigned char rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + + // unsigned long long to X + template bool compare( unsigned long long lhs, int rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( unsigned long long lhs, long rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( unsigned long long lhs, long long rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + template bool compare( unsigned long long lhs, char rhs ) { + return applyEvaluator( static_cast( lhs ), rhs ); + } + + // pointer to long long (when comparing against NULL) + template bool compare( long long lhs, T* rhs ) { + return Evaluator::evaluate( reinterpret_cast( lhs ), rhs ); + } + template bool compare( T* lhs, long long rhs ) { + return Evaluator::evaluate( lhs, reinterpret_cast( rhs ) ); + } +#endif // CATCH_CONFIG_CPP11_LONG_LONG + +#ifdef CATCH_CONFIG_CPP11_NULLPTR + // pointer to nullptr_t (when comparing against nullptr) + template bool compare( std::nullptr_t, T* rhs ) { + return Evaluator::evaluate( nullptr, rhs ); + } + template bool compare( T* lhs, std::nullptr_t ) { + return Evaluator::evaluate( lhs, nullptr ); + } +#endif // CATCH_CONFIG_CPP11_NULLPTR + +} // end of namespace Internal +} // end of namespace Catch + +#ifdef _MSC_VER +#pragma warning(pop) +#endif + +// #included from: catch_tostring.h +#define TWOBLUECUBES_CATCH_TOSTRING_H_INCLUDED + +#include +#include +#include +#include +#include + +#ifdef __OBJC__ +// #included from: catch_objc_arc.hpp +#define TWOBLUECUBES_CATCH_OBJC_ARC_HPP_INCLUDED + +#import + +#ifdef __has_feature +#define CATCH_ARC_ENABLED __has_feature(objc_arc) +#else +#define CATCH_ARC_ENABLED 0 +#endif + +void arcSafeRelease( NSObject* obj ); +id performOptionalSelector( id obj, SEL sel ); + +#if !CATCH_ARC_ENABLED +inline void arcSafeRelease( NSObject* obj ) { + [obj release]; +} +inline id performOptionalSelector( id obj, SEL sel ) { + if( [obj respondsToSelector: sel] ) + return [obj performSelector: sel]; + return nil; +} +#define CATCH_UNSAFE_UNRETAINED +#define CATCH_ARC_STRONG +#else +inline void arcSafeRelease( NSObject* ){} +inline id performOptionalSelector( id obj, SEL sel ) { +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Warc-performSelector-leaks" +#endif + if( [obj respondsToSelector: sel] ) + return [obj performSelector: sel]; +#ifdef __clang__ +#pragma clang diagnostic pop +#endif + return nil; +} +#define CATCH_UNSAFE_UNRETAINED __unsafe_unretained +#define CATCH_ARC_STRONG __strong +#endif + +#endif + +#ifdef CATCH_CONFIG_CPP11_TUPLE +#include +#endif + +#ifdef CATCH_CONFIG_CPP11_IS_ENUM +#include +#endif + +namespace Catch { + +// Why we're here. +template +std::string toString( T const& value ); + +// Built in overloads + +std::string toString( std::string const& value ); +std::string toString( std::wstring const& value ); +std::string toString( const char* const value ); +std::string toString( char* const value ); +std::string toString( const wchar_t* const value ); +std::string toString( wchar_t* const value ); +std::string toString( int value ); +std::string toString( unsigned long value ); +std::string toString( unsigned int value ); +std::string toString( const double value ); +std::string toString( const float value ); +std::string toString( bool value ); +std::string toString( char value ); +std::string toString( signed char value ); +std::string toString( unsigned char value ); + +#ifdef CATCH_CONFIG_CPP11_LONG_LONG +std::string toString( long long value ); +std::string toString( unsigned long long value ); +#endif + +#ifdef CATCH_CONFIG_CPP11_NULLPTR +std::string toString( std::nullptr_t ); +#endif + +#ifdef __OBJC__ + std::string toString( NSString const * const& nsstring ); + std::string toString( NSString * CATCH_ARC_STRONG const& nsstring ); + std::string toString( NSObject* const& nsObject ); +#endif + +namespace Detail { + + extern const std::string unprintableString; + + struct BorgType { + template BorgType( T const& ); + }; + + struct TrueType { char sizer[1]; }; + struct FalseType { char sizer[2]; }; + + TrueType& testStreamable( std::ostream& ); + FalseType testStreamable( FalseType ); + + FalseType operator<<( std::ostream const&, BorgType const& ); + + template + struct IsStreamInsertable { + static std::ostream &s; + static T const&t; + enum { value = sizeof( testStreamable(s << t) ) == sizeof( TrueType ) }; + }; + +#if defined(CATCH_CONFIG_CPP11_IS_ENUM) + template::value + > + struct EnumStringMaker + { + static std::string convert( T const& ) { return unprintableString; } + }; + + template + struct EnumStringMaker + { + static std::string convert( T const& v ) + { + return ::Catch::toString( + static_cast::type>(v) + ); + } + }; +#endif + template + struct StringMakerBase { +#if defined(CATCH_CONFIG_CPP11_IS_ENUM) + template + static std::string convert( T const& v ) + { + return EnumStringMaker::convert( v ); + } +#else + template + static std::string convert( T const& ) { return unprintableString; } +#endif + }; + + template<> + struct StringMakerBase { + template + static std::string convert( T const& _value ) { + std::ostringstream oss; + oss << _value; + return oss.str(); + } + }; + + std::string rawMemoryToString( const void *object, std::size_t size ); + + template + inline std::string rawMemoryToString( const T& object ) { + return rawMemoryToString( &object, sizeof(object) ); + } + +} // end namespace Detail + +template +struct StringMaker : + Detail::StringMakerBase::value> {}; + +template +struct StringMaker { + template + static std::string convert( U* p ) { + if( !p ) + return "NULL"; + else + return Detail::rawMemoryToString( p ); + } +}; + +template +struct StringMaker { + static std::string convert( R C::* p ) { + if( !p ) + return "NULL"; + else + return Detail::rawMemoryToString( p ); + } +}; + +namespace Detail { + template + std::string rangeToString( InputIterator first, InputIterator last ); +} + +//template +//struct StringMaker > { +// static std::string convert( std::vector const& v ) { +// return Detail::rangeToString( v.begin(), v.end() ); +// } +//}; + +template +std::string toString( std::vector const& v ) { + return Detail::rangeToString( v.begin(), v.end() ); +} + +#ifdef CATCH_CONFIG_CPP11_TUPLE + +// toString for tuples +namespace TupleDetail { + template< + typename Tuple, + std::size_t N = 0, + bool = (N < std::tuple_size::value) + > + struct ElementPrinter { + static void print( const Tuple& tuple, std::ostream& os ) + { + os << ( N ? ", " : " " ) + << Catch::toString(std::get(tuple)); + ElementPrinter::print(tuple,os); + } + }; + + template< + typename Tuple, + std::size_t N + > + struct ElementPrinter { + static void print( const Tuple&, std::ostream& ) {} + }; + +} + +template +struct StringMaker> { + + static std::string convert( const std::tuple& tuple ) + { + std::ostringstream os; + os << '{'; + TupleDetail::ElementPrinter>::print( tuple, os ); + os << " }"; + return os.str(); + } +}; +#endif // CATCH_CONFIG_CPP11_TUPLE + +namespace Detail { + template + std::string makeString( T const& value ) { + return StringMaker::convert( value ); + } +} // end namespace Detail + +/// \brief converts any type to a string +/// +/// The default template forwards on to ostringstream - except when an +/// ostringstream overload does not exist - in which case it attempts to detect +/// that and writes {?}. +/// Overload (not specialise) this template for custom typs that you don't want +/// to provide an ostream overload for. +template +std::string toString( T const& value ) { + return StringMaker::convert( value ); +} + + namespace Detail { + template + std::string rangeToString( InputIterator first, InputIterator last ) { + std::ostringstream oss; + oss << "{ "; + if( first != last ) { + oss << Catch::toString( *first ); + for( ++first ; first != last ; ++first ) + oss << ", " << Catch::toString( *first ); + } + oss << " }"; + return oss.str(); + } +} + +} // end namespace Catch + +namespace Catch { + +// Wraps the LHS of an expression and captures the operator and RHS (if any) - +// wrapping them all in a ResultBuilder object +template +class ExpressionLhs { + ExpressionLhs& operator = ( ExpressionLhs const& ); +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + ExpressionLhs& operator = ( ExpressionLhs && ) = delete; +# endif + +public: + ExpressionLhs( ResultBuilder& rb, T lhs ) : m_rb( rb ), m_lhs( lhs ) {} +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + ExpressionLhs( ExpressionLhs const& ) = default; + ExpressionLhs( ExpressionLhs && ) = default; +# endif + + template + ResultBuilder& operator == ( RhsT const& rhs ) { + return captureExpression( rhs ); + } + + template + ResultBuilder& operator != ( RhsT const& rhs ) { + return captureExpression( rhs ); + } + + template + ResultBuilder& operator < ( RhsT const& rhs ) { + return captureExpression( rhs ); + } + + template + ResultBuilder& operator > ( RhsT const& rhs ) { + return captureExpression( rhs ); + } + + template + ResultBuilder& operator <= ( RhsT const& rhs ) { + return captureExpression( rhs ); + } + + template + ResultBuilder& operator >= ( RhsT const& rhs ) { + return captureExpression( rhs ); + } + + ResultBuilder& operator == ( bool rhs ) { + return captureExpression( rhs ); + } + + ResultBuilder& operator != ( bool rhs ) { + return captureExpression( rhs ); + } + + void endExpression() { + bool value = m_lhs ? true : false; + m_rb + .setLhs( Catch::toString( value ) ) + .setResultType( value ) + .endExpression(); + } + + // Only simple binary expressions are allowed on the LHS. + // If more complex compositions are required then place the sub expression in parentheses + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator + ( RhsT const& ); + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator - ( RhsT const& ); + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator / ( RhsT const& ); + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator * ( RhsT const& ); + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator && ( RhsT const& ); + template STATIC_ASSERT_Expression_Too_Complex_Please_Rewrite_As_Binary_Comparison& operator || ( RhsT const& ); + +private: + template + ResultBuilder& captureExpression( RhsT const& rhs ) { + return m_rb + .setResultType( Internal::compare( m_lhs, rhs ) ) + .setLhs( Catch::toString( m_lhs ) ) + .setRhs( Catch::toString( rhs ) ) + .setOp( Internal::OperatorTraits::getName() ); + } + +private: + ResultBuilder& m_rb; + T m_lhs; +}; + +} // end namespace Catch + + +namespace Catch { + + template + inline ExpressionLhs ResultBuilder::operator <= ( T const& operand ) { + return ExpressionLhs( *this, operand ); + } + + inline ExpressionLhs ResultBuilder::operator <= ( bool value ) { + return ExpressionLhs( *this, value ); + } + +} // namespace Catch + +// #included from: catch_message.h +#define TWOBLUECUBES_CATCH_MESSAGE_H_INCLUDED + +#include + +namespace Catch { + + struct MessageInfo { + MessageInfo( std::string const& _macroName, + SourceLineInfo const& _lineInfo, + ResultWas::OfType _type ); + + std::string macroName; + SourceLineInfo lineInfo; + ResultWas::OfType type; + std::string message; + unsigned int sequence; + + bool operator == ( MessageInfo const& other ) const { + return sequence == other.sequence; + } + bool operator < ( MessageInfo const& other ) const { + return sequence < other.sequence; + } + private: + static unsigned int globalCount; + }; + + struct MessageBuilder { + MessageBuilder( std::string const& macroName, + SourceLineInfo const& lineInfo, + ResultWas::OfType type ) + : m_info( macroName, lineInfo, type ) + {} + + template + MessageBuilder& operator << ( T const& value ) { + m_stream << value; + return *this; + } + + MessageInfo m_info; + std::ostringstream m_stream; + }; + + class ScopedMessage { + public: + ScopedMessage( MessageBuilder const& builder ); + ScopedMessage( ScopedMessage const& other ); + ~ScopedMessage(); + + MessageInfo m_info; + }; + +} // end namespace Catch + +// #included from: catch_interfaces_capture.h +#define TWOBLUECUBES_CATCH_INTERFACES_CAPTURE_H_INCLUDED + +#include + +namespace Catch { + + class TestCase; + class AssertionResult; + struct AssertionInfo; + struct SectionInfo; + struct SectionEndInfo; + struct MessageInfo; + class ScopedMessageBuilder; + struct Counts; + + struct IResultCapture { + + virtual ~IResultCapture(); + + virtual void assertionEnded( AssertionResult const& result ) = 0; + virtual bool sectionStarted( SectionInfo const& sectionInfo, + Counts& assertions ) = 0; + virtual void sectionEnded( SectionEndInfo const& endInfo ) = 0; + virtual void sectionEndedEarly( SectionEndInfo const& endInfo ) = 0; + virtual void pushScopedMessage( MessageInfo const& message ) = 0; + virtual void popScopedMessage( MessageInfo const& message ) = 0; + + virtual std::string getCurrentTestName() const = 0; + virtual const AssertionResult* getLastResult() const = 0; + + virtual void handleFatalErrorCondition( std::string const& message ) = 0; + }; + + IResultCapture& getResultCapture(); +} + +// #included from: catch_debugger.h +#define TWOBLUECUBES_CATCH_DEBUGGER_H_INCLUDED + +// #included from: catch_platform.h +#define TWOBLUECUBES_CATCH_PLATFORM_H_INCLUDED + +#if defined(__MAC_OS_X_VERSION_MIN_REQUIRED) +#define CATCH_PLATFORM_MAC +#elif defined(__IPHONE_OS_VERSION_MIN_REQUIRED) +#define CATCH_PLATFORM_IPHONE +#elif defined(WIN32) || defined(__WIN32__) || defined(_WIN32) || defined(_MSC_VER) +#define CATCH_PLATFORM_WINDOWS +#endif + +#include + +namespace Catch{ + + bool isDebuggerActive(); + void writeToDebugConsole( std::string const& text ); +} + +#ifdef CATCH_PLATFORM_MAC + + // The following code snippet based on: + // http://cocoawithlove.com/2008/03/break-into-debugger.html + #ifdef DEBUG + #if defined(__ppc64__) || defined(__ppc__) + #define CATCH_BREAK_INTO_DEBUGGER() \ + if( Catch::isDebuggerActive() ) { \ + __asm__("li r0, 20\nsc\nnop\nli r0, 37\nli r4, 2\nsc\nnop\n" \ + : : : "memory","r0","r3","r4" ); \ + } + #else + #define CATCH_BREAK_INTO_DEBUGGER() if( Catch::isDebuggerActive() ) {__asm__("int $3\n" : : );} + #endif + #endif + +#elif defined(_MSC_VER) + #define CATCH_BREAK_INTO_DEBUGGER() if( Catch::isDebuggerActive() ) { __debugbreak(); } +#elif defined(__MINGW32__) + extern "C" __declspec(dllimport) void __stdcall DebugBreak(); + #define CATCH_BREAK_INTO_DEBUGGER() if( Catch::isDebuggerActive() ) { DebugBreak(); } +#endif + +#ifndef CATCH_BREAK_INTO_DEBUGGER +#define CATCH_BREAK_INTO_DEBUGGER() Catch::alwaysTrue(); +#endif + +// #included from: catch_interfaces_runner.h +#define TWOBLUECUBES_CATCH_INTERFACES_RUNNER_H_INCLUDED + +namespace Catch { + class TestCase; + + struct IRunner { + virtual ~IRunner(); + virtual bool aborting() const = 0; + }; +} + +/////////////////////////////////////////////////////////////////////////////// +// In the event of a failure works out if the debugger needs to be invoked +// and/or an exception thrown and takes appropriate action. +// This needs to be done as a macro so the debugger will stop in the user +// source code rather than in Catch library code +#define INTERNAL_CATCH_REACT( resultBuilder ) \ + if( resultBuilder.shouldDebugBreak() ) CATCH_BREAK_INTO_DEBUGGER(); \ + resultBuilder.react(); + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_TEST( expr, resultDisposition, macroName ) \ + do { \ + Catch::ResultBuilder __catchResult( macroName, CATCH_INTERNAL_LINEINFO, #expr, resultDisposition ); \ + try { \ + CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS \ + ( __catchResult <= expr ).endExpression(); \ + } \ + catch( ... ) { \ + __catchResult.useActiveException( Catch::ResultDisposition::Normal ); \ + } \ + INTERNAL_CATCH_REACT( __catchResult ) \ + } while( Catch::isTrue( false && static_cast(expr) ) ) // expr here is never evaluated at runtime but it forces the compiler to give it a look + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_IF( expr, resultDisposition, macroName ) \ + INTERNAL_CATCH_TEST( expr, resultDisposition, macroName ); \ + if( Catch::getResultCapture().getLastResult()->succeeded() ) + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_ELSE( expr, resultDisposition, macroName ) \ + INTERNAL_CATCH_TEST( expr, resultDisposition, macroName ); \ + if( !Catch::getResultCapture().getLastResult()->succeeded() ) + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_NO_THROW( expr, resultDisposition, macroName ) \ + do { \ + Catch::ResultBuilder __catchResult( macroName, CATCH_INTERNAL_LINEINFO, #expr, resultDisposition ); \ + try { \ + expr; \ + __catchResult.captureResult( Catch::ResultWas::Ok ); \ + } \ + catch( ... ) { \ + __catchResult.useActiveException( resultDisposition ); \ + } \ + INTERNAL_CATCH_REACT( __catchResult ) \ + } while( Catch::alwaysFalse() ) + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_THROWS( expr, resultDisposition, matcher, macroName ) \ + do { \ + Catch::ResultBuilder __catchResult( macroName, CATCH_INTERNAL_LINEINFO, #expr, resultDisposition, #matcher ); \ + if( __catchResult.allowThrows() ) \ + try { \ + expr; \ + __catchResult.captureResult( Catch::ResultWas::DidntThrowException ); \ + } \ + catch( ... ) { \ + __catchResult.captureExpectedException( matcher ); \ + } \ + else \ + __catchResult.captureResult( Catch::ResultWas::Ok ); \ + INTERNAL_CATCH_REACT( __catchResult ) \ + } while( Catch::alwaysFalse() ) + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_THROWS_AS( expr, exceptionType, resultDisposition, macroName ) \ + do { \ + Catch::ResultBuilder __catchResult( macroName, CATCH_INTERNAL_LINEINFO, #expr, resultDisposition ); \ + if( __catchResult.allowThrows() ) \ + try { \ + expr; \ + __catchResult.captureResult( Catch::ResultWas::DidntThrowException ); \ + } \ + catch( exceptionType ) { \ + __catchResult.captureResult( Catch::ResultWas::Ok ); \ + } \ + catch( ... ) { \ + __catchResult.useActiveException( resultDisposition ); \ + } \ + else \ + __catchResult.captureResult( Catch::ResultWas::Ok ); \ + INTERNAL_CATCH_REACT( __catchResult ) \ + } while( Catch::alwaysFalse() ) + +/////////////////////////////////////////////////////////////////////////////// +#ifdef CATCH_CONFIG_VARIADIC_MACROS + #define INTERNAL_CATCH_MSG( messageType, resultDisposition, macroName, ... ) \ + do { \ + Catch::ResultBuilder __catchResult( macroName, CATCH_INTERNAL_LINEINFO, "", resultDisposition ); \ + __catchResult << __VA_ARGS__ + ::Catch::StreamEndStop(); \ + __catchResult.captureResult( messageType ); \ + INTERNAL_CATCH_REACT( __catchResult ) \ + } while( Catch::alwaysFalse() ) +#else + #define INTERNAL_CATCH_MSG( messageType, resultDisposition, macroName, log ) \ + do { \ + Catch::ResultBuilder __catchResult( macroName, CATCH_INTERNAL_LINEINFO, "", resultDisposition ); \ + __catchResult << log + ::Catch::StreamEndStop(); \ + __catchResult.captureResult( messageType ); \ + INTERNAL_CATCH_REACT( __catchResult ) \ + } while( Catch::alwaysFalse() ) +#endif + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_INFO( log, macroName ) \ + Catch::ScopedMessage INTERNAL_CATCH_UNIQUE_NAME( scopedMessage ) = Catch::MessageBuilder( macroName, CATCH_INTERNAL_LINEINFO, Catch::ResultWas::Info ) << log; + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CHECK_THAT( arg, matcher, resultDisposition, macroName ) \ + do { \ + Catch::ResultBuilder __catchResult( macroName, CATCH_INTERNAL_LINEINFO, #arg ", " #matcher, resultDisposition ); \ + try { \ + std::string matcherAsString = (matcher).toString(); \ + __catchResult \ + .setLhs( Catch::toString( arg ) ) \ + .setRhs( matcherAsString == Catch::Detail::unprintableString ? #matcher : matcherAsString ) \ + .setOp( "matches" ) \ + .setResultType( (matcher).match( arg ) ); \ + __catchResult.captureExpression(); \ + } catch( ... ) { \ + __catchResult.useActiveException( resultDisposition | Catch::ResultDisposition::ContinueOnFailure ); \ + } \ + INTERNAL_CATCH_REACT( __catchResult ) \ + } while( Catch::alwaysFalse() ) + +// #included from: internal/catch_section.h +#define TWOBLUECUBES_CATCH_SECTION_H_INCLUDED + +// #included from: catch_section_info.h +#define TWOBLUECUBES_CATCH_SECTION_INFO_H_INCLUDED + +// #included from: catch_totals.hpp +#define TWOBLUECUBES_CATCH_TOTALS_HPP_INCLUDED + +#include + +namespace Catch { + + struct Counts { + Counts() : passed( 0 ), failed( 0 ), failedButOk( 0 ) {} + + Counts operator - ( Counts const& other ) const { + Counts diff; + diff.passed = passed - other.passed; + diff.failed = failed - other.failed; + diff.failedButOk = failedButOk - other.failedButOk; + return diff; + } + Counts& operator += ( Counts const& other ) { + passed += other.passed; + failed += other.failed; + failedButOk += other.failedButOk; + return *this; + } + + std::size_t total() const { + return passed + failed + failedButOk; + } + bool allPassed() const { + return failed == 0 && failedButOk == 0; + } + bool allOk() const { + return failed == 0; + } + + std::size_t passed; + std::size_t failed; + std::size_t failedButOk; + }; + + struct Totals { + + Totals operator - ( Totals const& other ) const { + Totals diff; + diff.assertions = assertions - other.assertions; + diff.testCases = testCases - other.testCases; + return diff; + } + + Totals delta( Totals const& prevTotals ) const { + Totals diff = *this - prevTotals; + if( diff.assertions.failed > 0 ) + ++diff.testCases.failed; + else if( diff.assertions.failedButOk > 0 ) + ++diff.testCases.failedButOk; + else + ++diff.testCases.passed; + return diff; + } + + Totals& operator += ( Totals const& other ) { + assertions += other.assertions; + testCases += other.testCases; + return *this; + } + + Counts assertions; + Counts testCases; + }; +} + +namespace Catch { + + struct SectionInfo { + SectionInfo + ( SourceLineInfo const& _lineInfo, + std::string const& _name, + std::string const& _description = std::string() ); + + std::string name; + std::string description; + SourceLineInfo lineInfo; + }; + + struct SectionEndInfo { + SectionEndInfo( SectionInfo const& _sectionInfo, Counts const& _prevAssertions, double _durationInSeconds ) + : sectionInfo( _sectionInfo ), prevAssertions( _prevAssertions ), durationInSeconds( _durationInSeconds ) + {} + + SectionInfo sectionInfo; + Counts prevAssertions; + double durationInSeconds; + }; + +} // end namespace Catch + +// #included from: catch_timer.h +#define TWOBLUECUBES_CATCH_TIMER_H_INCLUDED + +#ifdef CATCH_PLATFORM_WINDOWS +typedef unsigned long long uint64_t; +#else +#include +#endif + +namespace Catch { + + class Timer { + public: + Timer() : m_ticks( 0 ) {} + void start(); + unsigned int getElapsedMicroseconds() const; + unsigned int getElapsedMilliseconds() const; + double getElapsedSeconds() const; + + private: + uint64_t m_ticks; + }; + +} // namespace Catch + +#include + +namespace Catch { + + class Section : NonCopyable { + public: + Section( SectionInfo const& info ); + ~Section(); + + // This indicates whether the section should be executed or not + operator bool() const; + + private: + SectionInfo m_info; + + std::string m_name; + Counts m_assertions; + bool m_sectionIncluded; + Timer m_timer; + }; + +} // end namespace Catch + +#ifdef CATCH_CONFIG_VARIADIC_MACROS + #define INTERNAL_CATCH_SECTION( ... ) \ + if( Catch::Section const& INTERNAL_CATCH_UNIQUE_NAME( catch_internal_Section ) = Catch::SectionInfo( CATCH_INTERNAL_LINEINFO, __VA_ARGS__ ) ) +#else + #define INTERNAL_CATCH_SECTION( name, desc ) \ + if( Catch::Section const& INTERNAL_CATCH_UNIQUE_NAME( catch_internal_Section ) = Catch::SectionInfo( CATCH_INTERNAL_LINEINFO, name, desc ) ) +#endif + +// #included from: internal/catch_generators.hpp +#define TWOBLUECUBES_CATCH_GENERATORS_HPP_INCLUDED + +#include +#include +#include +#include + +namespace Catch { + +template +struct IGenerator { + virtual ~IGenerator() {} + virtual T getValue( std::size_t index ) const = 0; + virtual std::size_t size () const = 0; +}; + +template +class BetweenGenerator : public IGenerator { +public: + BetweenGenerator( T from, T to ) : m_from( from ), m_to( to ){} + + virtual T getValue( std::size_t index ) const { + return m_from+static_cast( index ); + } + + virtual std::size_t size() const { + return static_cast( 1+m_to-m_from ); + } + +private: + + T m_from; + T m_to; +}; + +template +class ValuesGenerator : public IGenerator { +public: + ValuesGenerator(){} + + void add( T value ) { + m_values.push_back( value ); + } + + virtual T getValue( std::size_t index ) const { + return m_values[index]; + } + + virtual std::size_t size() const { + return m_values.size(); + } + +private: + std::vector m_values; +}; + +template +class CompositeGenerator { +public: + CompositeGenerator() : m_totalSize( 0 ) {} + + // *** Move semantics, similar to auto_ptr *** + CompositeGenerator( CompositeGenerator& other ) + : m_fileInfo( other.m_fileInfo ), + m_totalSize( 0 ) + { + move( other ); + } + + CompositeGenerator& setFileInfo( const char* fileInfo ) { + m_fileInfo = fileInfo; + return *this; + } + + ~CompositeGenerator() { + deleteAll( m_composed ); + } + + operator T () const { + size_t overallIndex = getCurrentContext().getGeneratorIndex( m_fileInfo, m_totalSize ); + + typename std::vector*>::const_iterator it = m_composed.begin(); + typename std::vector*>::const_iterator itEnd = m_composed.end(); + for( size_t index = 0; it != itEnd; ++it ) + { + const IGenerator* generator = *it; + if( overallIndex >= index && overallIndex < index + generator->size() ) + { + return generator->getValue( overallIndex-index ); + } + index += generator->size(); + } + CATCH_INTERNAL_ERROR( "Indexed past end of generated range" ); + return T(); // Suppress spurious "not all control paths return a value" warning in Visual Studio - if you know how to fix this please do so + } + + void add( const IGenerator* generator ) { + m_totalSize += generator->size(); + m_composed.push_back( generator ); + } + + CompositeGenerator& then( CompositeGenerator& other ) { + move( other ); + return *this; + } + + CompositeGenerator& then( T value ) { + ValuesGenerator* valuesGen = new ValuesGenerator(); + valuesGen->add( value ); + add( valuesGen ); + return *this; + } + +private: + + void move( CompositeGenerator& other ) { + std::copy( other.m_composed.begin(), other.m_composed.end(), std::back_inserter( m_composed ) ); + m_totalSize += other.m_totalSize; + other.m_composed.clear(); + } + + std::vector*> m_composed; + std::string m_fileInfo; + size_t m_totalSize; +}; + +namespace Generators +{ + template + CompositeGenerator between( T from, T to ) { + CompositeGenerator generators; + generators.add( new BetweenGenerator( from, to ) ); + return generators; + } + + template + CompositeGenerator values( T val1, T val2 ) { + CompositeGenerator generators; + ValuesGenerator* valuesGen = new ValuesGenerator(); + valuesGen->add( val1 ); + valuesGen->add( val2 ); + generators.add( valuesGen ); + return generators; + } + + template + CompositeGenerator values( T val1, T val2, T val3 ){ + CompositeGenerator generators; + ValuesGenerator* valuesGen = new ValuesGenerator(); + valuesGen->add( val1 ); + valuesGen->add( val2 ); + valuesGen->add( val3 ); + generators.add( valuesGen ); + return generators; + } + + template + CompositeGenerator values( T val1, T val2, T val3, T val4 ) { + CompositeGenerator generators; + ValuesGenerator* valuesGen = new ValuesGenerator(); + valuesGen->add( val1 ); + valuesGen->add( val2 ); + valuesGen->add( val3 ); + valuesGen->add( val4 ); + generators.add( valuesGen ); + return generators; + } + +} // end namespace Generators + +using namespace Generators; + +} // end namespace Catch + +#define INTERNAL_CATCH_LINESTR2( line ) #line +#define INTERNAL_CATCH_LINESTR( line ) INTERNAL_CATCH_LINESTR2( line ) + +#define INTERNAL_CATCH_GENERATE( expr ) expr.setFileInfo( __FILE__ "(" INTERNAL_CATCH_LINESTR( __LINE__ ) ")" ) + +// #included from: internal/catch_interfaces_exception.h +#define TWOBLUECUBES_CATCH_INTERFACES_EXCEPTION_H_INCLUDED + +#include +#include + +// #included from: catch_interfaces_registry_hub.h +#define TWOBLUECUBES_CATCH_INTERFACES_REGISTRY_HUB_H_INCLUDED + +#include + +namespace Catch { + + class TestCase; + struct ITestCaseRegistry; + struct IExceptionTranslatorRegistry; + struct IExceptionTranslator; + struct IReporterRegistry; + struct IReporterFactory; + + struct IRegistryHub { + virtual ~IRegistryHub(); + + virtual IReporterRegistry const& getReporterRegistry() const = 0; + virtual ITestCaseRegistry const& getTestCaseRegistry() const = 0; + virtual IExceptionTranslatorRegistry& getExceptionTranslatorRegistry() = 0; + }; + + struct IMutableRegistryHub { + virtual ~IMutableRegistryHub(); + virtual void registerReporter( std::string const& name, Ptr const& factory ) = 0; + virtual void registerListener( Ptr const& factory ) = 0; + virtual void registerTest( TestCase const& testInfo ) = 0; + virtual void registerTranslator( const IExceptionTranslator* translator ) = 0; + }; + + IRegistryHub& getRegistryHub(); + IMutableRegistryHub& getMutableRegistryHub(); + void cleanUp(); + std::string translateActiveException(); + +} + +namespace Catch { + + typedef std::string(*exceptionTranslateFunction)(); + + struct IExceptionTranslator; + typedef std::vector ExceptionTranslators; + + struct IExceptionTranslator { + virtual ~IExceptionTranslator(); + virtual std::string translate( ExceptionTranslators::const_iterator it, ExceptionTranslators::const_iterator itEnd ) const = 0; + }; + + struct IExceptionTranslatorRegistry { + virtual ~IExceptionTranslatorRegistry(); + + virtual std::string translateActiveException() const = 0; + }; + + class ExceptionTranslatorRegistrar { + template + class ExceptionTranslator : public IExceptionTranslator { + public: + + ExceptionTranslator( std::string(*translateFunction)( T& ) ) + : m_translateFunction( translateFunction ) + {} + + virtual std::string translate( ExceptionTranslators::const_iterator it, ExceptionTranslators::const_iterator itEnd ) const CATCH_OVERRIDE { + try { + if( it == itEnd ) + throw; + else + return (*it)->translate( it+1, itEnd ); + } + catch( T& ex ) { + return m_translateFunction( ex ); + } + } + + protected: + std::string(*m_translateFunction)( T& ); + }; + + public: + template + ExceptionTranslatorRegistrar( std::string(*translateFunction)( T& ) ) { + getMutableRegistryHub().registerTranslator + ( new ExceptionTranslator( translateFunction ) ); + } + }; +} + +/////////////////////////////////////////////////////////////////////////////// +#define INTERNAL_CATCH_TRANSLATE_EXCEPTION2( translatorName, signature ) \ + static std::string translatorName( signature ); \ + namespace{ Catch::ExceptionTranslatorRegistrar INTERNAL_CATCH_UNIQUE_NAME( catch_internal_ExceptionRegistrar )( &translatorName ); }\ + static std::string translatorName( signature ) + +#define INTERNAL_CATCH_TRANSLATE_EXCEPTION( signature ) INTERNAL_CATCH_TRANSLATE_EXCEPTION2( INTERNAL_CATCH_UNIQUE_NAME( catch_internal_ExceptionTranslator ), signature ) + +// #included from: internal/catch_approx.hpp +#define TWOBLUECUBES_CATCH_APPROX_HPP_INCLUDED + +#include +#include + +namespace Catch { +namespace Detail { + + class Approx { + public: + explicit Approx ( double value ) + : m_epsilon( std::numeric_limits::epsilon()*100 ), + m_scale( 1.0 ), + m_value( value ) + {} + + Approx( Approx const& other ) + : m_epsilon( other.m_epsilon ), + m_scale( other.m_scale ), + m_value( other.m_value ) + {} + + static Approx custom() { + return Approx( 0 ); + } + + Approx operator()( double value ) { + Approx approx( value ); + approx.epsilon( m_epsilon ); + approx.scale( m_scale ); + return approx; + } + + friend bool operator == ( double lhs, Approx const& rhs ) { + // Thanks to Richard Harris for his help refining this formula + return fabs( lhs - rhs.m_value ) < rhs.m_epsilon * (rhs.m_scale + (std::max)( fabs(lhs), fabs(rhs.m_value) ) ); + } + + friend bool operator == ( Approx const& lhs, double rhs ) { + return operator==( rhs, lhs ); + } + + friend bool operator != ( double lhs, Approx const& rhs ) { + return !operator==( lhs, rhs ); + } + + friend bool operator != ( Approx const& lhs, double rhs ) { + return !operator==( rhs, lhs ); + } + + Approx& epsilon( double newEpsilon ) { + m_epsilon = newEpsilon; + return *this; + } + + Approx& scale( double newScale ) { + m_scale = newScale; + return *this; + } + + std::string toString() const { + std::ostringstream oss; + oss << "Approx( " << Catch::toString( m_value ) << " )"; + return oss.str(); + } + + private: + double m_epsilon; + double m_scale; + double m_value; + }; +} + +template<> +inline std::string toString( Detail::Approx const& value ) { + return value.toString(); +} + +} // end namespace Catch + +// #included from: internal/catch_interfaces_tag_alias_registry.h +#define TWOBLUECUBES_CATCH_INTERFACES_TAG_ALIAS_REGISTRY_H_INCLUDED + +// #included from: catch_tag_alias.h +#define TWOBLUECUBES_CATCH_TAG_ALIAS_H_INCLUDED + +#include + +namespace Catch { + + struct TagAlias { + TagAlias( std::string _tag, SourceLineInfo _lineInfo ) : tag( _tag ), lineInfo( _lineInfo ) {} + + std::string tag; + SourceLineInfo lineInfo; + }; + + struct RegistrarForTagAliases { + RegistrarForTagAliases( char const* alias, char const* tag, SourceLineInfo const& lineInfo ); + }; + +} // end namespace Catch + +#define CATCH_REGISTER_TAG_ALIAS( alias, spec ) namespace{ Catch::RegistrarForTagAliases INTERNAL_CATCH_UNIQUE_NAME( AutoRegisterTagAlias )( alias, spec, CATCH_INTERNAL_LINEINFO ); } +// #included from: catch_option.hpp +#define TWOBLUECUBES_CATCH_OPTION_HPP_INCLUDED + +namespace Catch { + + // An optional type + template + class Option { + public: + Option() : nullableValue( CATCH_NULL ) {} + Option( T const& _value ) + : nullableValue( new( storage ) T( _value ) ) + {} + Option( Option const& _other ) + : nullableValue( _other ? new( storage ) T( *_other ) : CATCH_NULL ) + {} + + ~Option() { + reset(); + } + + Option& operator= ( Option const& _other ) { + if( &_other != this ) { + reset(); + if( _other ) + nullableValue = new( storage ) T( *_other ); + } + return *this; + } + Option& operator = ( T const& _value ) { + reset(); + nullableValue = new( storage ) T( _value ); + return *this; + } + + void reset() { + if( nullableValue ) + nullableValue->~T(); + nullableValue = CATCH_NULL; + } + + T& operator*() { return *nullableValue; } + T const& operator*() const { return *nullableValue; } + T* operator->() { return nullableValue; } + const T* operator->() const { return nullableValue; } + + T valueOr( T const& defaultValue ) const { + return nullableValue ? *nullableValue : defaultValue; + } + + bool some() const { return nullableValue != CATCH_NULL; } + bool none() const { return nullableValue == CATCH_NULL; } + + bool operator !() const { return nullableValue == CATCH_NULL; } + operator SafeBool::type() const { + return SafeBool::makeSafe( some() ); + } + + private: + T* nullableValue; + char storage[sizeof(T)]; + }; + +} // end namespace Catch + +namespace Catch { + + struct ITagAliasRegistry { + virtual ~ITagAliasRegistry(); + virtual Option find( std::string const& alias ) const = 0; + virtual std::string expandAliases( std::string const& unexpandedTestSpec ) const = 0; + + static ITagAliasRegistry const& get(); + }; + +} // end namespace Catch + +// These files are included here so the single_include script doesn't put them +// in the conditionally compiled sections +// #included from: internal/catch_test_case_info.h +#define TWOBLUECUBES_CATCH_TEST_CASE_INFO_H_INCLUDED + +#include +#include + +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wpadded" +#endif + +namespace Catch { + + struct ITestCase; + + struct TestCaseInfo { + enum SpecialProperties{ + None = 0, + IsHidden = 1 << 1, + ShouldFail = 1 << 2, + MayFail = 1 << 3, + Throws = 1 << 4 + }; + + TestCaseInfo( std::string const& _name, + std::string const& _className, + std::string const& _description, + std::set const& _tags, + SourceLineInfo const& _lineInfo ); + + TestCaseInfo( TestCaseInfo const& other ); + + friend void setTags( TestCaseInfo& testCaseInfo, std::set const& tags ); + + bool isHidden() const; + bool throws() const; + bool okToFail() const; + bool expectedToFail() const; + + std::string name; + std::string className; + std::string description; + std::set tags; + std::set lcaseTags; + std::string tagsAsString; + SourceLineInfo lineInfo; + SpecialProperties properties; + }; + + class TestCase : public TestCaseInfo { + public: + + TestCase( ITestCase* testCase, TestCaseInfo const& info ); + TestCase( TestCase const& other ); + + TestCase withName( std::string const& _newName ) const; + + void invoke() const; + + TestCaseInfo const& getTestCaseInfo() const; + + void swap( TestCase& other ); + bool operator == ( TestCase const& other ) const; + bool operator < ( TestCase const& other ) const; + TestCase& operator = ( TestCase const& other ); + + private: + Ptr test; + }; + + TestCase makeTestCase( ITestCase* testCase, + std::string const& className, + std::string const& name, + std::string const& description, + SourceLineInfo const& lineInfo ); +} + +#ifdef __clang__ +#pragma clang diagnostic pop +#endif + + +#ifdef __OBJC__ +// #included from: internal/catch_objc.hpp +#define TWOBLUECUBES_CATCH_OBJC_HPP_INCLUDED + +#import + +#include + +// NB. Any general catch headers included here must be included +// in catch.hpp first to make sure they are included by the single +// header for non obj-usage + +/////////////////////////////////////////////////////////////////////////////// +// This protocol is really only here for (self) documenting purposes, since +// all its methods are optional. +@protocol OcFixture + +@optional + +-(void) setUp; +-(void) tearDown; + +@end + +namespace Catch { + + class OcMethod : public SharedImpl { + + public: + OcMethod( Class cls, SEL sel ) : m_cls( cls ), m_sel( sel ) {} + + virtual void invoke() const { + id obj = [[m_cls alloc] init]; + + performOptionalSelector( obj, @selector(setUp) ); + performOptionalSelector( obj, m_sel ); + performOptionalSelector( obj, @selector(tearDown) ); + + arcSafeRelease( obj ); + } + private: + virtual ~OcMethod() {} + + Class m_cls; + SEL m_sel; + }; + + namespace Detail{ + + inline std::string getAnnotation( Class cls, + std::string const& annotationName, + std::string const& testCaseName ) { + NSString* selStr = [[NSString alloc] initWithFormat:@"Catch_%s_%s", annotationName.c_str(), testCaseName.c_str()]; + SEL sel = NSSelectorFromString( selStr ); + arcSafeRelease( selStr ); + id value = performOptionalSelector( cls, sel ); + if( value ) + return [(NSString*)value UTF8String]; + return ""; + } + } + + inline size_t registerTestMethods() { + size_t noTestMethods = 0; + int noClasses = objc_getClassList( CATCH_NULL, 0 ); + + Class* classes = (CATCH_UNSAFE_UNRETAINED Class *)malloc( sizeof(Class) * noClasses); + objc_getClassList( classes, noClasses ); + + for( int c = 0; c < noClasses; c++ ) { + Class cls = classes[c]; + { + u_int count; + Method* methods = class_copyMethodList( cls, &count ); + for( u_int m = 0; m < count ; m++ ) { + SEL selector = method_getName(methods[m]); + std::string methodName = sel_getName(selector); + if( startsWith( methodName, "Catch_TestCase_" ) ) { + std::string testCaseName = methodName.substr( 15 ); + std::string name = Detail::getAnnotation( cls, "Name", testCaseName ); + std::string desc = Detail::getAnnotation( cls, "Description", testCaseName ); + const char* className = class_getName( cls ); + + getMutableRegistryHub().registerTest( makeTestCase( new OcMethod( cls, selector ), className, name.c_str(), desc.c_str(), SourceLineInfo() ) ); + noTestMethods++; + } + } + free(methods); + } + } + return noTestMethods; + } + + namespace Matchers { + namespace Impl { + namespace NSStringMatchers { + + template + struct StringHolder : MatcherImpl{ + StringHolder( NSString* substr ) : m_substr( [substr copy] ){} + StringHolder( StringHolder const& other ) : m_substr( [other.m_substr copy] ){} + StringHolder() { + arcSafeRelease( m_substr ); + } + + NSString* m_substr; + }; + + struct Equals : StringHolder { + Equals( NSString* substr ) : StringHolder( substr ){} + + virtual bool match( ExpressionType const& str ) const { + return (str != nil || m_substr == nil ) && + [str isEqualToString:m_substr]; + } + + virtual std::string toString() const { + return "equals string: " + Catch::toString( m_substr ); + } + }; + + struct Contains : StringHolder { + Contains( NSString* substr ) : StringHolder( substr ){} + + virtual bool match( ExpressionType const& str ) const { + return (str != nil || m_substr == nil ) && + [str rangeOfString:m_substr].location != NSNotFound; + } + + virtual std::string toString() const { + return "contains string: " + Catch::toString( m_substr ); + } + }; + + struct StartsWith : StringHolder { + StartsWith( NSString* substr ) : StringHolder( substr ){} + + virtual bool match( ExpressionType const& str ) const { + return (str != nil || m_substr == nil ) && + [str rangeOfString:m_substr].location == 0; + } + + virtual std::string toString() const { + return "starts with: " + Catch::toString( m_substr ); + } + }; + struct EndsWith : StringHolder { + EndsWith( NSString* substr ) : StringHolder( substr ){} + + virtual bool match( ExpressionType const& str ) const { + return (str != nil || m_substr == nil ) && + [str rangeOfString:m_substr].location == [str length] - [m_substr length]; + } + + virtual std::string toString() const { + return "ends with: " + Catch::toString( m_substr ); + } + }; + + } // namespace NSStringMatchers + } // namespace Impl + + inline Impl::NSStringMatchers::Equals + Equals( NSString* substr ){ return Impl::NSStringMatchers::Equals( substr ); } + + inline Impl::NSStringMatchers::Contains + Contains( NSString* substr ){ return Impl::NSStringMatchers::Contains( substr ); } + + inline Impl::NSStringMatchers::StartsWith + StartsWith( NSString* substr ){ return Impl::NSStringMatchers::StartsWith( substr ); } + + inline Impl::NSStringMatchers::EndsWith + EndsWith( NSString* substr ){ return Impl::NSStringMatchers::EndsWith( substr ); } + + } // namespace Matchers + + using namespace Matchers; + +} // namespace Catch + +/////////////////////////////////////////////////////////////////////////////// +#define OC_TEST_CASE( name, desc )\ ++(NSString*) INTERNAL_CATCH_UNIQUE_NAME( Catch_Name_test ) \ +{\ +return @ name; \ +}\ ++(NSString*) INTERNAL_CATCH_UNIQUE_NAME( Catch_Description_test ) \ +{ \ +return @ desc; \ +} \ +-(void) INTERNAL_CATCH_UNIQUE_NAME( Catch_TestCase_test ) + +#endif + +#ifdef CATCH_IMPL +// #included from: internal/catch_impl.hpp +#define TWOBLUECUBES_CATCH_IMPL_HPP_INCLUDED + +// Collect all the implementation files together here +// These are the equivalent of what would usually be cpp files + +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wweak-vtables" +#endif + +// #included from: ../catch_session.hpp +#define TWOBLUECUBES_CATCH_RUNNER_HPP_INCLUDED + +// #included from: internal/catch_commandline.hpp +#define TWOBLUECUBES_CATCH_COMMANDLINE_HPP_INCLUDED + +// #included from: catch_config.hpp +#define TWOBLUECUBES_CATCH_CONFIG_HPP_INCLUDED + +// #included from: catch_test_spec_parser.hpp +#define TWOBLUECUBES_CATCH_TEST_SPEC_PARSER_HPP_INCLUDED + +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wpadded" +#endif + +// #included from: catch_test_spec.hpp +#define TWOBLUECUBES_CATCH_TEST_SPEC_HPP_INCLUDED + +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wpadded" +#endif + +// #included from: catch_wildcard_pattern.hpp +#define TWOBLUECUBES_CATCH_WILDCARD_PATTERN_HPP_INCLUDED + +namespace Catch +{ + class WildcardPattern { + enum WildcardPosition { + NoWildcard = 0, + WildcardAtStart = 1, + WildcardAtEnd = 2, + WildcardAtBothEnds = WildcardAtStart | WildcardAtEnd + }; + + public: + + WildcardPattern( std::string const& pattern, CaseSensitive::Choice caseSensitivity ) + : m_caseSensitivity( caseSensitivity ), + m_wildcard( NoWildcard ), + m_pattern( adjustCase( pattern ) ) + { + if( startsWith( m_pattern, "*" ) ) { + m_pattern = m_pattern.substr( 1 ); + m_wildcard = WildcardAtStart; + } + if( endsWith( m_pattern, "*" ) ) { + m_pattern = m_pattern.substr( 0, m_pattern.size()-1 ); + m_wildcard = static_cast( m_wildcard | WildcardAtEnd ); + } + } + virtual ~WildcardPattern(); + virtual bool matches( std::string const& str ) const { + switch( m_wildcard ) { + case NoWildcard: + return m_pattern == adjustCase( str ); + case WildcardAtStart: + return endsWith( adjustCase( str ), m_pattern ); + case WildcardAtEnd: + return startsWith( adjustCase( str ), m_pattern ); + case WildcardAtBothEnds: + return contains( adjustCase( str ), m_pattern ); + } + +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wunreachable-code" +#endif + throw std::logic_error( "Unknown enum" ); +#ifdef __clang__ +#pragma clang diagnostic pop +#endif + } + private: + std::string adjustCase( std::string const& str ) const { + return m_caseSensitivity == CaseSensitive::No ? toLower( str ) : str; + } + CaseSensitive::Choice m_caseSensitivity; + WildcardPosition m_wildcard; + std::string m_pattern; + }; +} + +#include +#include + +namespace Catch { + + class TestSpec { + struct Pattern : SharedImpl<> { + virtual ~Pattern(); + virtual bool matches( TestCaseInfo const& testCase ) const = 0; + }; + class NamePattern : public Pattern { + public: + NamePattern( std::string const& name ) + : m_wildcardPattern( toLower( name ), CaseSensitive::No ) + {} + virtual ~NamePattern(); + virtual bool matches( TestCaseInfo const& testCase ) const { + return m_wildcardPattern.matches( toLower( testCase.name ) ); + } + private: + WildcardPattern m_wildcardPattern; + }; + + class TagPattern : public Pattern { + public: + TagPattern( std::string const& tag ) : m_tag( toLower( tag ) ) {} + virtual ~TagPattern(); + virtual bool matches( TestCaseInfo const& testCase ) const { + return testCase.lcaseTags.find( m_tag ) != testCase.lcaseTags.end(); + } + private: + std::string m_tag; + }; + + class ExcludedPattern : public Pattern { + public: + ExcludedPattern( Ptr const& underlyingPattern ) : m_underlyingPattern( underlyingPattern ) {} + virtual ~ExcludedPattern(); + virtual bool matches( TestCaseInfo const& testCase ) const { return !m_underlyingPattern->matches( testCase ); } + private: + Ptr m_underlyingPattern; + }; + + struct Filter { + std::vector > m_patterns; + + bool matches( TestCaseInfo const& testCase ) const { + // All patterns in a filter must match for the filter to be a match + for( std::vector >::const_iterator it = m_patterns.begin(), itEnd = m_patterns.end(); it != itEnd; ++it ) + if( !(*it)->matches( testCase ) ) + return false; + return true; + } + }; + + public: + bool hasFilters() const { + return !m_filters.empty(); + } + bool matches( TestCaseInfo const& testCase ) const { + // A TestSpec matches if any filter matches + for( std::vector::const_iterator it = m_filters.begin(), itEnd = m_filters.end(); it != itEnd; ++it ) + if( it->matches( testCase ) ) + return true; + return false; + } + + private: + std::vector m_filters; + + friend class TestSpecParser; + }; +} + +#ifdef __clang__ +#pragma clang diagnostic pop +#endif + +namespace Catch { + + class TestSpecParser { + enum Mode{ None, Name, QuotedName, Tag }; + Mode m_mode; + bool m_exclusion; + std::size_t m_start, m_pos; + std::string m_arg; + TestSpec::Filter m_currentFilter; + TestSpec m_testSpec; + ITagAliasRegistry const* m_tagAliases; + + public: + TestSpecParser( ITagAliasRegistry const& tagAliases ) : m_tagAliases( &tagAliases ) {} + + TestSpecParser& parse( std::string const& arg ) { + m_mode = None; + m_exclusion = false; + m_start = std::string::npos; + m_arg = m_tagAliases->expandAliases( arg ); + for( m_pos = 0; m_pos < m_arg.size(); ++m_pos ) + visitChar( m_arg[m_pos] ); + if( m_mode == Name ) + addPattern(); + return *this; + } + TestSpec testSpec() { + addFilter(); + return m_testSpec; + } + private: + void visitChar( char c ) { + if( m_mode == None ) { + switch( c ) { + case ' ': return; + case '~': m_exclusion = true; return; + case '[': return startNewMode( Tag, ++m_pos ); + case '"': return startNewMode( QuotedName, ++m_pos ); + default: startNewMode( Name, m_pos ); break; + } + } + if( m_mode == Name ) { + if( c == ',' ) { + addPattern(); + addFilter(); + } + else if( c == '[' ) { + if( subString() == "exclude:" ) + m_exclusion = true; + else + addPattern(); + startNewMode( Tag, ++m_pos ); + } + } + else if( m_mode == QuotedName && c == '"' ) + addPattern(); + else if( m_mode == Tag && c == ']' ) + addPattern(); + } + void startNewMode( Mode mode, std::size_t start ) { + m_mode = mode; + m_start = start; + } + std::string subString() const { return m_arg.substr( m_start, m_pos - m_start ); } + template + void addPattern() { + std::string token = subString(); + if( startsWith( token, "exclude:" ) ) { + m_exclusion = true; + token = token.substr( 8 ); + } + if( !token.empty() ) { + Ptr pattern = new T( token ); + if( m_exclusion ) + pattern = new TestSpec::ExcludedPattern( pattern ); + m_currentFilter.m_patterns.push_back( pattern ); + } + m_exclusion = false; + m_mode = None; + } + void addFilter() { + if( !m_currentFilter.m_patterns.empty() ) { + m_testSpec.m_filters.push_back( m_currentFilter ); + m_currentFilter = TestSpec::Filter(); + } + } + }; + inline TestSpec parseTestSpec( std::string const& arg ) { + return TestSpecParser( ITagAliasRegistry::get() ).parse( arg ).testSpec(); + } + +} // namespace Catch + +#ifdef __clang__ +#pragma clang diagnostic pop +#endif + +// #included from: catch_interfaces_config.h +#define TWOBLUECUBES_CATCH_INTERFACES_CONFIG_H_INCLUDED + +#include +#include +#include + +namespace Catch { + + struct Verbosity { enum Level { + NoOutput = 0, + Quiet, + Normal + }; }; + + struct WarnAbout { enum What { + Nothing = 0x00, + NoAssertions = 0x01 + }; }; + + struct ShowDurations { enum OrNot { + DefaultForReporter, + Always, + Never + }; }; + struct RunTests { enum InWhatOrder { + InDeclarationOrder, + InLexicographicalOrder, + InRandomOrder + }; }; + struct UseColour { enum YesOrNo { + Auto, + Yes, + No + }; }; + + class TestSpec; + + struct IConfig : IShared { + + virtual ~IConfig(); + + virtual bool allowThrows() const = 0; + virtual std::ostream& stream() const = 0; + virtual std::string name() const = 0; + virtual bool includeSuccessfulResults() const = 0; + virtual bool shouldDebugBreak() const = 0; + virtual bool warnAboutMissingAssertions() const = 0; + virtual int abortAfter() const = 0; + virtual bool showInvisibles() const = 0; + virtual ShowDurations::OrNot showDurations() const = 0; + virtual TestSpec const& testSpec() const = 0; + virtual RunTests::InWhatOrder runOrder() const = 0; + virtual unsigned int rngSeed() const = 0; + virtual UseColour::YesOrNo useColour() const = 0; + }; +} + +// #included from: catch_stream.h +#define TWOBLUECUBES_CATCH_STREAM_H_INCLUDED + +// #included from: catch_streambuf.h +#define TWOBLUECUBES_CATCH_STREAMBUF_H_INCLUDED + +#include + +namespace Catch { + + class StreamBufBase : public std::streambuf { + public: + virtual ~StreamBufBase() CATCH_NOEXCEPT; + }; +} + +#include +#include +#include + +namespace Catch { + + std::ostream& cout(); + std::ostream& cerr(); + + struct IStream { + virtual ~IStream() CATCH_NOEXCEPT; + virtual std::ostream& stream() const = 0; + }; + + class FileStream : public IStream { + mutable std::ofstream m_ofs; + public: + FileStream( std::string const& filename ); + virtual ~FileStream() CATCH_NOEXCEPT; + public: // IStream + virtual std::ostream& stream() const CATCH_OVERRIDE; + }; + + class CoutStream : public IStream { + mutable std::ostream m_os; + public: + CoutStream(); + virtual ~CoutStream() CATCH_NOEXCEPT; + + public: // IStream + virtual std::ostream& stream() const CATCH_OVERRIDE; + }; + + class DebugOutStream : public IStream { + std::auto_ptr m_streamBuf; + mutable std::ostream m_os; + public: + DebugOutStream(); + virtual ~DebugOutStream() CATCH_NOEXCEPT; + + public: // IStream + virtual std::ostream& stream() const CATCH_OVERRIDE; + }; +} + +#include +#include +#include +#include +#include + +#ifndef CATCH_CONFIG_CONSOLE_WIDTH +#define CATCH_CONFIG_CONSOLE_WIDTH 80 +#endif + +namespace Catch { + + struct ConfigData { + + ConfigData() + : listTests( false ), + listTags( false ), + listReporters( false ), + listTestNamesOnly( false ), + showSuccessfulTests( false ), + shouldDebugBreak( false ), + noThrow( false ), + showHelp( false ), + showInvisibles( false ), + filenamesAsTags( false ), + abortAfter( -1 ), + rngSeed( 0 ), + verbosity( Verbosity::Normal ), + warnings( WarnAbout::Nothing ), + showDurations( ShowDurations::DefaultForReporter ), + runOrder( RunTests::InDeclarationOrder ), + useColour( UseColour::Auto ) + {} + + bool listTests; + bool listTags; + bool listReporters; + bool listTestNamesOnly; + + bool showSuccessfulTests; + bool shouldDebugBreak; + bool noThrow; + bool showHelp; + bool showInvisibles; + bool filenamesAsTags; + + int abortAfter; + unsigned int rngSeed; + + Verbosity::Level verbosity; + WarnAbout::What warnings; + ShowDurations::OrNot showDurations; + RunTests::InWhatOrder runOrder; + UseColour::YesOrNo useColour; + + std::string outputFilename; + std::string name; + std::string processName; + + std::vector reporterNames; + std::vector testsOrTags; + }; + + class Config : public SharedImpl { + private: + Config( Config const& other ); + Config& operator = ( Config const& other ); + virtual void dummy(); + public: + + Config() + {} + + Config( ConfigData const& data ) + : m_data( data ), + m_stream( openStream() ) + { + if( !data.testsOrTags.empty() ) { + TestSpecParser parser( ITagAliasRegistry::get() ); + for( std::size_t i = 0; i < data.testsOrTags.size(); ++i ) + parser.parse( data.testsOrTags[i] ); + m_testSpec = parser.testSpec(); + } + } + + virtual ~Config() { + } + + std::string const& getFilename() const { + return m_data.outputFilename ; + } + + bool listTests() const { return m_data.listTests; } + bool listTestNamesOnly() const { return m_data.listTestNamesOnly; } + bool listTags() const { return m_data.listTags; } + bool listReporters() const { return m_data.listReporters; } + + std::string getProcessName() const { return m_data.processName; } + + bool shouldDebugBreak() const { return m_data.shouldDebugBreak; } + + std::vector getReporterNames() const { return m_data.reporterNames; } + + int abortAfter() const { return m_data.abortAfter; } + + TestSpec const& testSpec() const { return m_testSpec; } + + bool showHelp() const { return m_data.showHelp; } + bool showInvisibles() const { return m_data.showInvisibles; } + + // IConfig interface + virtual bool allowThrows() const { return !m_data.noThrow; } + virtual std::ostream& stream() const { return m_stream->stream(); } + virtual std::string name() const { return m_data.name.empty() ? m_data.processName : m_data.name; } + virtual bool includeSuccessfulResults() const { return m_data.showSuccessfulTests; } + virtual bool warnAboutMissingAssertions() const { return m_data.warnings & WarnAbout::NoAssertions; } + virtual ShowDurations::OrNot showDurations() const { return m_data.showDurations; } + virtual RunTests::InWhatOrder runOrder() const { return m_data.runOrder; } + virtual unsigned int rngSeed() const { return m_data.rngSeed; } + virtual UseColour::YesOrNo useColour() const { return m_data.useColour; } + + private: + + IStream const* openStream() { + if( m_data.outputFilename.empty() ) + return new CoutStream(); + else if( m_data.outputFilename[0] == '%' ) { + if( m_data.outputFilename == "%debug" ) + return new DebugOutStream(); + else + throw std::domain_error( "Unrecognised stream: " + m_data.outputFilename ); + } + else + return new FileStream( m_data.outputFilename ); + } + ConfigData m_data; + + std::auto_ptr m_stream; + TestSpec m_testSpec; + }; + +} // end namespace Catch + +// #included from: catch_clara.h +#define TWOBLUECUBES_CATCH_CLARA_H_INCLUDED + +// Use Catch's value for console width (store Clara's off to the side, if present) +#ifdef CLARA_CONFIG_CONSOLE_WIDTH +#define CATCH_TEMP_CLARA_CONFIG_CONSOLE_WIDTH CLARA_CONFIG_CONSOLE_WIDTH +#undef CLARA_CONFIG_CONSOLE_WIDTH +#endif +#define CLARA_CONFIG_CONSOLE_WIDTH CATCH_CONFIG_CONSOLE_WIDTH + +// Declare Clara inside the Catch namespace +#define STITCH_CLARA_OPEN_NAMESPACE namespace Catch { +// #included from: ../external/clara.h + +// Version 0.0.1.1 + +// Only use header guard if we are not using an outer namespace +#if !defined(TWOBLUECUBES_CLARA_H_INCLUDED) || defined(STITCH_CLARA_OPEN_NAMESPACE) + +#ifndef STITCH_CLARA_OPEN_NAMESPACE +#define TWOBLUECUBES_CLARA_H_INCLUDED +#define STITCH_CLARA_OPEN_NAMESPACE +#define STITCH_CLARA_CLOSE_NAMESPACE +#else +#define STITCH_CLARA_CLOSE_NAMESPACE } +#endif + +#define STITCH_TBC_TEXT_FORMAT_OPEN_NAMESPACE STITCH_CLARA_OPEN_NAMESPACE + +// ----------- #included from tbc_text_format.h ----------- + +// Only use header guard if we are not using an outer namespace +#if !defined(TBC_TEXT_FORMAT_H_INCLUDED) || defined(STITCH_TBC_TEXT_FORMAT_OUTER_NAMESPACE) +#ifndef STITCH_TBC_TEXT_FORMAT_OUTER_NAMESPACE +#define TBC_TEXT_FORMAT_H_INCLUDED +#endif + +#include +#include +#include +#include + +// Use optional outer namespace +#ifdef STITCH_TBC_TEXT_FORMAT_OUTER_NAMESPACE +namespace STITCH_TBC_TEXT_FORMAT_OUTER_NAMESPACE { +#endif + +namespace Tbc { + +#ifdef TBC_TEXT_FORMAT_CONSOLE_WIDTH + const unsigned int consoleWidth = TBC_TEXT_FORMAT_CONSOLE_WIDTH; +#else + const unsigned int consoleWidth = 80; +#endif + + struct TextAttributes { + TextAttributes() + : initialIndent( std::string::npos ), + indent( 0 ), + width( consoleWidth-1 ), + tabChar( '\t' ) + {} + + TextAttributes& setInitialIndent( std::size_t _value ) { initialIndent = _value; return *this; } + TextAttributes& setIndent( std::size_t _value ) { indent = _value; return *this; } + TextAttributes& setWidth( std::size_t _value ) { width = _value; return *this; } + TextAttributes& setTabChar( char _value ) { tabChar = _value; return *this; } + + std::size_t initialIndent; // indent of first line, or npos + std::size_t indent; // indent of subsequent lines, or all if initialIndent is npos + std::size_t width; // maximum width of text, including indent. Longer text will wrap + char tabChar; // If this char is seen the indent is changed to current pos + }; + + class Text { + public: + Text( std::string const& _str, TextAttributes const& _attr = TextAttributes() ) + : attr( _attr ) + { + std::string wrappableChars = " [({.,/|\\-"; + std::size_t indent = _attr.initialIndent != std::string::npos + ? _attr.initialIndent + : _attr.indent; + std::string remainder = _str; + + while( !remainder.empty() ) { + if( lines.size() >= 1000 ) { + lines.push_back( "... message truncated due to excessive size" ); + return; + } + std::size_t tabPos = std::string::npos; + std::size_t width = (std::min)( remainder.size(), _attr.width - indent ); + std::size_t pos = remainder.find_first_of( '\n' ); + if( pos <= width ) { + width = pos; + } + pos = remainder.find_last_of( _attr.tabChar, width ); + if( pos != std::string::npos ) { + tabPos = pos; + if( remainder[width] == '\n' ) + width--; + remainder = remainder.substr( 0, tabPos ) + remainder.substr( tabPos+1 ); + } + + if( width == remainder.size() ) { + spliceLine( indent, remainder, width ); + } + else if( remainder[width] == '\n' ) { + spliceLine( indent, remainder, width ); + if( width <= 1 || remainder.size() != 1 ) + remainder = remainder.substr( 1 ); + indent = _attr.indent; + } + else { + pos = remainder.find_last_of( wrappableChars, width ); + if( pos != std::string::npos && pos > 0 ) { + spliceLine( indent, remainder, pos ); + if( remainder[0] == ' ' ) + remainder = remainder.substr( 1 ); + } + else { + spliceLine( indent, remainder, width-1 ); + lines.back() += "-"; + } + if( lines.size() == 1 ) + indent = _attr.indent; + if( tabPos != std::string::npos ) + indent += tabPos; + } + } + } + + void spliceLine( std::size_t _indent, std::string& _remainder, std::size_t _pos ) { + lines.push_back( std::string( _indent, ' ' ) + _remainder.substr( 0, _pos ) ); + _remainder = _remainder.substr( _pos ); + } + + typedef std::vector::const_iterator const_iterator; + + const_iterator begin() const { return lines.begin(); } + const_iterator end() const { return lines.end(); } + std::string const& last() const { return lines.back(); } + std::size_t size() const { return lines.size(); } + std::string const& operator[]( std::size_t _index ) const { return lines[_index]; } + std::string toString() const { + std::ostringstream oss; + oss << *this; + return oss.str(); + } + + inline friend std::ostream& operator << ( std::ostream& _stream, Text const& _text ) { + for( Text::const_iterator it = _text.begin(), itEnd = _text.end(); + it != itEnd; ++it ) { + if( it != _text.begin() ) + _stream << "\n"; + _stream << *it; + } + return _stream; + } + + private: + std::string str; + TextAttributes attr; + std::vector lines; + }; + +} // end namespace Tbc + +#ifdef STITCH_TBC_TEXT_FORMAT_OUTER_NAMESPACE +} // end outer namespace +#endif + +#endif // TBC_TEXT_FORMAT_H_INCLUDED + +// ----------- end of #include from tbc_text_format.h ----------- +// ........... back in clara.h + +#undef STITCH_TBC_TEXT_FORMAT_OPEN_NAMESPACE + +// ----------- #included from clara_compilers.h ----------- + +#ifndef TWOBLUECUBES_CLARA_COMPILERS_H_INCLUDED +#define TWOBLUECUBES_CLARA_COMPILERS_H_INCLUDED + +// Detect a number of compiler features - mostly C++11/14 conformance - by compiler +// The following features are defined: +// +// CLARA_CONFIG_CPP11_NULLPTR : is nullptr supported? +// CLARA_CONFIG_CPP11_NOEXCEPT : is noexcept supported? +// CLARA_CONFIG_CPP11_GENERATED_METHODS : The delete and default keywords for compiler generated methods +// CLARA_CONFIG_CPP11_OVERRIDE : is override supported? +// CLARA_CONFIG_CPP11_UNIQUE_PTR : is unique_ptr supported (otherwise use auto_ptr) + +// CLARA_CONFIG_CPP11_OR_GREATER : Is C++11 supported? + +// CLARA_CONFIG_VARIADIC_MACROS : are variadic macros supported? + +// In general each macro has a _NO_ form +// (e.g. CLARA_CONFIG_CPP11_NO_NULLPTR) which disables the feature. +// Many features, at point of detection, define an _INTERNAL_ macro, so they +// can be combined, en-mass, with the _NO_ forms later. + +// All the C++11 features can be disabled with CLARA_CONFIG_NO_CPP11 + +#ifdef __clang__ + +#if __has_feature(cxx_nullptr) +#define CLARA_INTERNAL_CONFIG_CPP11_NULLPTR +#endif + +#if __has_feature(cxx_noexcept) +#define CLARA_INTERNAL_CONFIG_CPP11_NOEXCEPT +#endif + +#endif // __clang__ + +//////////////////////////////////////////////////////////////////////////////// +// GCC +#ifdef __GNUC__ + +#if __GNUC__ == 4 && __GNUC_MINOR__ >= 6 && defined(__GXX_EXPERIMENTAL_CXX0X__) +#define CLARA_INTERNAL_CONFIG_CPP11_NULLPTR +#endif + +// - otherwise more recent versions define __cplusplus >= 201103L +// and will get picked up below + +#endif // __GNUC__ + +//////////////////////////////////////////////////////////////////////////////// +// Visual C++ +#ifdef _MSC_VER + +#if (_MSC_VER >= 1600) +#define CLARA_INTERNAL_CONFIG_CPP11_NULLPTR +#define CLARA_INTERNAL_CONFIG_CPP11_UNIQUE_PTR +#endif + +#if (_MSC_VER >= 1900 ) // (VC++ 13 (VS2015)) +#define CLARA_INTERNAL_CONFIG_CPP11_NOEXCEPT +#define CLARA_INTERNAL_CONFIG_CPP11_GENERATED_METHODS +#endif + +#endif // _MSC_VER + +//////////////////////////////////////////////////////////////////////////////// +// C++ language feature support + +// catch all support for C++11 +#if defined(__cplusplus) && __cplusplus >= 201103L + +#define CLARA_CPP11_OR_GREATER + +#if !defined(CLARA_INTERNAL_CONFIG_CPP11_NULLPTR) +#define CLARA_INTERNAL_CONFIG_CPP11_NULLPTR +#endif + +#ifndef CLARA_INTERNAL_CONFIG_CPP11_NOEXCEPT +#define CLARA_INTERNAL_CONFIG_CPP11_NOEXCEPT +#endif + +#ifndef CLARA_INTERNAL_CONFIG_CPP11_GENERATED_METHODS +#define CLARA_INTERNAL_CONFIG_CPP11_GENERATED_METHODS +#endif + +#if !defined(CLARA_INTERNAL_CONFIG_CPP11_OVERRIDE) +#define CLARA_INTERNAL_CONFIG_CPP11_OVERRIDE +#endif +#if !defined(CLARA_INTERNAL_CONFIG_CPP11_UNIQUE_PTR) +#define CLARA_INTERNAL_CONFIG_CPP11_UNIQUE_PTR +#endif + +#endif // __cplusplus >= 201103L + +// Now set the actual defines based on the above + anything the user has configured +#if defined(CLARA_INTERNAL_CONFIG_CPP11_NULLPTR) && !defined(CLARA_CONFIG_CPP11_NO_NULLPTR) && !defined(CLARA_CONFIG_CPP11_NULLPTR) && !defined(CLARA_CONFIG_NO_CPP11) +#define CLARA_CONFIG_CPP11_NULLPTR +#endif +#if defined(CLARA_INTERNAL_CONFIG_CPP11_NOEXCEPT) && !defined(CLARA_CONFIG_CPP11_NO_NOEXCEPT) && !defined(CLARA_CONFIG_CPP11_NOEXCEPT) && !defined(CLARA_CONFIG_NO_CPP11) +#define CLARA_CONFIG_CPP11_NOEXCEPT +#endif +#if defined(CLARA_INTERNAL_CONFIG_CPP11_GENERATED_METHODS) && !defined(CLARA_CONFIG_CPP11_NO_GENERATED_METHODS) && !defined(CLARA_CONFIG_CPP11_GENERATED_METHODS) && !defined(CLARA_CONFIG_NO_CPP11) +#define CLARA_CONFIG_CPP11_GENERATED_METHODS +#endif +#if defined(CLARA_INTERNAL_CONFIG_CPP11_OVERRIDE) && !defined(CLARA_CONFIG_NO_OVERRIDE) && !defined(CLARA_CONFIG_CPP11_OVERRIDE) && !defined(CLARA_CONFIG_NO_CPP11) +#define CLARA_CONFIG_CPP11_OVERRIDE +#endif +#if defined(CLARA_INTERNAL_CONFIG_CPP11_UNIQUE_PTR) && !defined(CLARA_CONFIG_NO_UNIQUE_PTR) && !defined(CLARA_CONFIG_CPP11_UNIQUE_PTR) && !defined(CLARA_CONFIG_NO_CPP11) +#define CLARA_CONFIG_CPP11_UNIQUE_PTR +#endif + +// noexcept support: +#if defined(CLARA_CONFIG_CPP11_NOEXCEPT) && !defined(CLARA_NOEXCEPT) +#define CLARA_NOEXCEPT noexcept +# define CLARA_NOEXCEPT_IS(x) noexcept(x) +#else +#define CLARA_NOEXCEPT throw() +# define CLARA_NOEXCEPT_IS(x) +#endif + +// nullptr support +#ifdef CLARA_CONFIG_CPP11_NULLPTR +#define CLARA_NULL nullptr +#else +#define CLARA_NULL NULL +#endif + +// override support +#ifdef CLARA_CONFIG_CPP11_OVERRIDE +#define CLARA_OVERRIDE override +#else +#define CLARA_OVERRIDE +#endif + +// unique_ptr support +#ifdef CLARA_CONFIG_CPP11_UNIQUE_PTR +# define CLARA_AUTO_PTR( T ) std::unique_ptr +#else +# define CLARA_AUTO_PTR( T ) std::auto_ptr +#endif + +#endif // TWOBLUECUBES_CLARA_COMPILERS_H_INCLUDED + +// ----------- end of #include from clara_compilers.h ----------- +// ........... back in clara.h + +#include +#include +#include + +// Use optional outer namespace +#ifdef STITCH_CLARA_OPEN_NAMESPACE +STITCH_CLARA_OPEN_NAMESPACE +#endif + +namespace Clara { + + struct UnpositionalTag {}; + + extern UnpositionalTag _; + +#ifdef CLARA_CONFIG_MAIN + UnpositionalTag _; +#endif + + namespace Detail { + +#ifdef CLARA_CONSOLE_WIDTH + const unsigned int consoleWidth = CLARA_CONFIG_CONSOLE_WIDTH; +#else + const unsigned int consoleWidth = 80; +#endif + + // Use this to try and stop compiler from warning about unreachable code + inline bool isTrue( bool value ) { return value; } + + using namespace Tbc; + + inline bool startsWith( std::string const& str, std::string const& prefix ) { + return str.size() >= prefix.size() && str.substr( 0, prefix.size() ) == prefix; + } + + template struct RemoveConstRef{ typedef T type; }; + template struct RemoveConstRef{ typedef T type; }; + template struct RemoveConstRef{ typedef T type; }; + template struct RemoveConstRef{ typedef T type; }; + + template struct IsBool { static const bool value = false; }; + template<> struct IsBool { static const bool value = true; }; + + template + void convertInto( std::string const& _source, T& _dest ) { + std::stringstream ss; + ss << _source; + ss >> _dest; + if( ss.fail() ) + throw std::runtime_error( "Unable to convert " + _source + " to destination type" ); + } + inline void convertInto( std::string const& _source, std::string& _dest ) { + _dest = _source; + } + inline void convertInto( std::string const& _source, bool& _dest ) { + std::string sourceLC = _source; + std::transform( sourceLC.begin(), sourceLC.end(), sourceLC.begin(), ::tolower ); + if( sourceLC == "y" || sourceLC == "1" || sourceLC == "true" || sourceLC == "yes" || sourceLC == "on" ) + _dest = true; + else if( sourceLC == "n" || sourceLC == "0" || sourceLC == "false" || sourceLC == "no" || sourceLC == "off" ) + _dest = false; + else + throw std::runtime_error( "Expected a boolean value but did not recognise:\n '" + _source + "'" ); + } + inline void convertInto( bool _source, bool& _dest ) { + _dest = _source; + } + template + inline void convertInto( bool, T& ) { + if( isTrue( true ) ) + throw std::runtime_error( "Invalid conversion" ); + } + + template + struct IArgFunction { + virtual ~IArgFunction() {} +#ifdef CLARA_CONFIG_CPP11_GENERATED_METHODS + IArgFunction() = default; + IArgFunction( IArgFunction const& ) = default; +#endif + virtual void set( ConfigT& config, std::string const& value ) const = 0; + virtual void setFlag( ConfigT& config ) const = 0; + virtual bool takesArg() const = 0; + virtual IArgFunction* clone() const = 0; + }; + + template + class BoundArgFunction { + public: + BoundArgFunction() : functionObj( CLARA_NULL ) {} + BoundArgFunction( IArgFunction* _functionObj ) : functionObj( _functionObj ) {} + BoundArgFunction( BoundArgFunction const& other ) : functionObj( other.functionObj ? other.functionObj->clone() : CLARA_NULL ) {} + BoundArgFunction& operator = ( BoundArgFunction const& other ) { + IArgFunction* newFunctionObj = other.functionObj ? other.functionObj->clone() : CLARA_NULL; + delete functionObj; + functionObj = newFunctionObj; + return *this; + } + ~BoundArgFunction() { delete functionObj; } + + void set( ConfigT& config, std::string const& value ) const { + functionObj->set( config, value ); + } + void setFlag( ConfigT& config ) const { + functionObj->setFlag( config ); + } + bool takesArg() const { return functionObj->takesArg(); } + + bool isSet() const { + return functionObj != CLARA_NULL; + } + private: + IArgFunction* functionObj; + }; + + template + struct NullBinder : IArgFunction{ + virtual void set( C&, std::string const& ) const {} + virtual void setFlag( C& ) const {} + virtual bool takesArg() const { return true; } + virtual IArgFunction* clone() const { return new NullBinder( *this ); } + }; + + template + struct BoundDataMember : IArgFunction{ + BoundDataMember( M C::* _member ) : member( _member ) {} + virtual void set( C& p, std::string const& stringValue ) const { + convertInto( stringValue, p.*member ); + } + virtual void setFlag( C& p ) const { + convertInto( true, p.*member ); + } + virtual bool takesArg() const { return !IsBool::value; } + virtual IArgFunction* clone() const { return new BoundDataMember( *this ); } + M C::* member; + }; + template + struct BoundUnaryMethod : IArgFunction{ + BoundUnaryMethod( void (C::*_member)( M ) ) : member( _member ) {} + virtual void set( C& p, std::string const& stringValue ) const { + typename RemoveConstRef::type value; + convertInto( stringValue, value ); + (p.*member)( value ); + } + virtual void setFlag( C& p ) const { + typename RemoveConstRef::type value; + convertInto( true, value ); + (p.*member)( value ); + } + virtual bool takesArg() const { return !IsBool::value; } + virtual IArgFunction* clone() const { return new BoundUnaryMethod( *this ); } + void (C::*member)( M ); + }; + template + struct BoundNullaryMethod : IArgFunction{ + BoundNullaryMethod( void (C::*_member)() ) : member( _member ) {} + virtual void set( C& p, std::string const& stringValue ) const { + bool value; + convertInto( stringValue, value ); + if( value ) + (p.*member)(); + } + virtual void setFlag( C& p ) const { + (p.*member)(); + } + virtual bool takesArg() const { return false; } + virtual IArgFunction* clone() const { return new BoundNullaryMethod( *this ); } + void (C::*member)(); + }; + + template + struct BoundUnaryFunction : IArgFunction{ + BoundUnaryFunction( void (*_function)( C& ) ) : function( _function ) {} + virtual void set( C& obj, std::string const& stringValue ) const { + bool value; + convertInto( stringValue, value ); + if( value ) + function( obj ); + } + virtual void setFlag( C& p ) const { + function( p ); + } + virtual bool takesArg() const { return false; } + virtual IArgFunction* clone() const { return new BoundUnaryFunction( *this ); } + void (*function)( C& ); + }; + + template + struct BoundBinaryFunction : IArgFunction{ + BoundBinaryFunction( void (*_function)( C&, T ) ) : function( _function ) {} + virtual void set( C& obj, std::string const& stringValue ) const { + typename RemoveConstRef::type value; + convertInto( stringValue, value ); + function( obj, value ); + } + virtual void setFlag( C& obj ) const { + typename RemoveConstRef::type value; + convertInto( true, value ); + function( obj, value ); + } + virtual bool takesArg() const { return !IsBool::value; } + virtual IArgFunction* clone() const { return new BoundBinaryFunction( *this ); } + void (*function)( C&, T ); + }; + + } // namespace Detail + + struct Parser { + Parser() : separators( " \t=:" ) {} + + struct Token { + enum Type { Positional, ShortOpt, LongOpt }; + Token( Type _type, std::string const& _data ) : type( _type ), data( _data ) {} + Type type; + std::string data; + }; + + void parseIntoTokens( int argc, char const* const argv[], std::vector& tokens ) const { + const std::string doubleDash = "--"; + for( int i = 1; i < argc && argv[i] != doubleDash; ++i ) + parseIntoTokens( argv[i] , tokens); + } + void parseIntoTokens( std::string arg, std::vector& tokens ) const { + while( !arg.empty() ) { + Parser::Token token( Parser::Token::Positional, arg ); + arg = ""; + if( token.data[0] == '-' ) { + if( token.data.size() > 1 && token.data[1] == '-' ) { + token = Parser::Token( Parser::Token::LongOpt, token.data.substr( 2 ) ); + } + else { + token = Parser::Token( Parser::Token::ShortOpt, token.data.substr( 1 ) ); + if( token.data.size() > 1 && separators.find( token.data[1] ) == std::string::npos ) { + arg = "-" + token.data.substr( 1 ); + token.data = token.data.substr( 0, 1 ); + } + } + } + if( token.type != Parser::Token::Positional ) { + std::size_t pos = token.data.find_first_of( separators ); + if( pos != std::string::npos ) { + arg = token.data.substr( pos+1 ); + token.data = token.data.substr( 0, pos ); + } + } + tokens.push_back( token ); + } + } + std::string separators; + }; + + template + struct CommonArgProperties { + CommonArgProperties() {} + CommonArgProperties( Detail::BoundArgFunction const& _boundField ) : boundField( _boundField ) {} + + Detail::BoundArgFunction boundField; + std::string description; + std::string detail; + std::string placeholder; // Only value if boundField takes an arg + + bool takesArg() const { + return !placeholder.empty(); + } + void validate() const { + if( !boundField.isSet() ) + throw std::logic_error( "option not bound" ); + } + }; + struct OptionArgProperties { + std::vector shortNames; + std::string longName; + + bool hasShortName( std::string const& shortName ) const { + return std::find( shortNames.begin(), shortNames.end(), shortName ) != shortNames.end(); + } + bool hasLongName( std::string const& _longName ) const { + return _longName == longName; + } + }; + struct PositionalArgProperties { + PositionalArgProperties() : position( -1 ) {} + int position; // -1 means non-positional (floating) + + bool isFixedPositional() const { + return position != -1; + } + }; + + template + class CommandLine { + + struct Arg : CommonArgProperties, OptionArgProperties, PositionalArgProperties { + Arg() {} + Arg( Detail::BoundArgFunction const& _boundField ) : CommonArgProperties( _boundField ) {} + + using CommonArgProperties::placeholder; // !TBD + + std::string dbgName() const { + if( !longName.empty() ) + return "--" + longName; + if( !shortNames.empty() ) + return "-" + shortNames[0]; + return "positional args"; + } + std::string commands() const { + std::ostringstream oss; + bool first = true; + std::vector::const_iterator it = shortNames.begin(), itEnd = shortNames.end(); + for(; it != itEnd; ++it ) { + if( first ) + first = false; + else + oss << ", "; + oss << "-" << *it; + } + if( !longName.empty() ) { + if( !first ) + oss << ", "; + oss << "--" << longName; + } + if( !placeholder.empty() ) + oss << " <" << placeholder << ">"; + return oss.str(); + } + }; + + typedef CLARA_AUTO_PTR( Arg ) ArgAutoPtr; + + friend void addOptName( Arg& arg, std::string const& optName ) + { + if( optName.empty() ) + return; + if( Detail::startsWith( optName, "--" ) ) { + if( !arg.longName.empty() ) + throw std::logic_error( "Only one long opt may be specified. '" + + arg.longName + + "' already specified, now attempting to add '" + + optName + "'" ); + arg.longName = optName.substr( 2 ); + } + else if( Detail::startsWith( optName, "-" ) ) + arg.shortNames.push_back( optName.substr( 1 ) ); + else + throw std::logic_error( "option must begin with - or --. Option was: '" + optName + "'" ); + } + friend void setPositionalArg( Arg& arg, int position ) + { + arg.position = position; + } + + class ArgBuilder { + public: + ArgBuilder( Arg* arg ) : m_arg( arg ) {} + + // Bind a non-boolean data member (requires placeholder string) + template + void bind( M C::* field, std::string const& placeholder ) { + m_arg->boundField = new Detail::BoundDataMember( field ); + m_arg->placeholder = placeholder; + } + // Bind a boolean data member (no placeholder required) + template + void bind( bool C::* field ) { + m_arg->boundField = new Detail::BoundDataMember( field ); + } + + // Bind a method taking a single, non-boolean argument (requires a placeholder string) + template + void bind( void (C::* unaryMethod)( M ), std::string const& placeholder ) { + m_arg->boundField = new Detail::BoundUnaryMethod( unaryMethod ); + m_arg->placeholder = placeholder; + } + + // Bind a method taking a single, boolean argument (no placeholder string required) + template + void bind( void (C::* unaryMethod)( bool ) ) { + m_arg->boundField = new Detail::BoundUnaryMethod( unaryMethod ); + } + + // Bind a method that takes no arguments (will be called if opt is present) + template + void bind( void (C::* nullaryMethod)() ) { + m_arg->boundField = new Detail::BoundNullaryMethod( nullaryMethod ); + } + + // Bind a free function taking a single argument - the object to operate on (no placeholder string required) + template + void bind( void (* unaryFunction)( C& ) ) { + m_arg->boundField = new Detail::BoundUnaryFunction( unaryFunction ); + } + + // Bind a free function taking a single argument - the object to operate on (requires a placeholder string) + template + void bind( void (* binaryFunction)( C&, T ), std::string const& placeholder ) { + m_arg->boundField = new Detail::BoundBinaryFunction( binaryFunction ); + m_arg->placeholder = placeholder; + } + + ArgBuilder& describe( std::string const& description ) { + m_arg->description = description; + return *this; + } + ArgBuilder& detail( std::string const& detail ) { + m_arg->detail = detail; + return *this; + } + + protected: + Arg* m_arg; + }; + + class OptBuilder : public ArgBuilder { + public: + OptBuilder( Arg* arg ) : ArgBuilder( arg ) {} + OptBuilder( OptBuilder& other ) : ArgBuilder( other ) {} + + OptBuilder& operator[]( std::string const& optName ) { + addOptName( *ArgBuilder::m_arg, optName ); + return *this; + } + }; + + public: + + CommandLine() + : m_boundProcessName( new Detail::NullBinder() ), + m_highestSpecifiedArgPosition( 0 ), + m_throwOnUnrecognisedTokens( false ) + {} + CommandLine( CommandLine const& other ) + : m_boundProcessName( other.m_boundProcessName ), + m_options ( other.m_options ), + m_positionalArgs( other.m_positionalArgs ), + m_highestSpecifiedArgPosition( other.m_highestSpecifiedArgPosition ), + m_throwOnUnrecognisedTokens( other.m_throwOnUnrecognisedTokens ) + { + if( other.m_floatingArg.get() ) + m_floatingArg.reset( new Arg( *other.m_floatingArg ) ); + } + + CommandLine& setThrowOnUnrecognisedTokens( bool shouldThrow = true ) { + m_throwOnUnrecognisedTokens = shouldThrow; + return *this; + } + + OptBuilder operator[]( std::string const& optName ) { + m_options.push_back( Arg() ); + addOptName( m_options.back(), optName ); + OptBuilder builder( &m_options.back() ); + return builder; + } + + ArgBuilder operator[]( int position ) { + m_positionalArgs.insert( std::make_pair( position, Arg() ) ); + if( position > m_highestSpecifiedArgPosition ) + m_highestSpecifiedArgPosition = position; + setPositionalArg( m_positionalArgs[position], position ); + ArgBuilder builder( &m_positionalArgs[position] ); + return builder; + } + + // Invoke this with the _ instance + ArgBuilder operator[]( UnpositionalTag ) { + if( m_floatingArg.get() ) + throw std::logic_error( "Only one unpositional argument can be added" ); + m_floatingArg.reset( new Arg() ); + ArgBuilder builder( m_floatingArg.get() ); + return builder; + } + + template + void bindProcessName( M C::* field ) { + m_boundProcessName = new Detail::BoundDataMember( field ); + } + template + void bindProcessName( void (C::*_unaryMethod)( M ) ) { + m_boundProcessName = new Detail::BoundUnaryMethod( _unaryMethod ); + } + + void optUsage( std::ostream& os, std::size_t indent = 0, std::size_t width = Detail::consoleWidth ) const { + typename std::vector::const_iterator itBegin = m_options.begin(), itEnd = m_options.end(), it; + std::size_t maxWidth = 0; + for( it = itBegin; it != itEnd; ++it ) + maxWidth = (std::max)( maxWidth, it->commands().size() ); + + for( it = itBegin; it != itEnd; ++it ) { + Detail::Text usage( it->commands(), Detail::TextAttributes() + .setWidth( maxWidth+indent ) + .setIndent( indent ) ); + Detail::Text desc( it->description, Detail::TextAttributes() + .setWidth( width - maxWidth - 3 ) ); + + for( std::size_t i = 0; i < (std::max)( usage.size(), desc.size() ); ++i ) { + std::string usageCol = i < usage.size() ? usage[i] : ""; + os << usageCol; + + if( i < desc.size() && !desc[i].empty() ) + os << std::string( indent + 2 + maxWidth - usageCol.size(), ' ' ) + << desc[i]; + os << "\n"; + } + } + } + std::string optUsage() const { + std::ostringstream oss; + optUsage( oss ); + return oss.str(); + } + + void argSynopsis( std::ostream& os ) const { + for( int i = 1; i <= m_highestSpecifiedArgPosition; ++i ) { + if( i > 1 ) + os << " "; + typename std::map::const_iterator it = m_positionalArgs.find( i ); + if( it != m_positionalArgs.end() ) + os << "<" << it->second.placeholder << ">"; + else if( m_floatingArg.get() ) + os << "<" << m_floatingArg->placeholder << ">"; + else + throw std::logic_error( "non consecutive positional arguments with no floating args" ); + } + // !TBD No indication of mandatory args + if( m_floatingArg.get() ) { + if( m_highestSpecifiedArgPosition > 1 ) + os << " "; + os << "[<" << m_floatingArg->placeholder << "> ...]"; + } + } + std::string argSynopsis() const { + std::ostringstream oss; + argSynopsis( oss ); + return oss.str(); + } + + void usage( std::ostream& os, std::string const& procName ) const { + validate(); + os << "usage:\n " << procName << " "; + argSynopsis( os ); + if( !m_options.empty() ) { + os << " [options]\n\nwhere options are: \n"; + optUsage( os, 2 ); + } + os << "\n"; + } + std::string usage( std::string const& procName ) const { + std::ostringstream oss; + usage( oss, procName ); + return oss.str(); + } + + ConfigT parse( int argc, char const* const argv[] ) const { + ConfigT config; + parseInto( argc, argv, config ); + return config; + } + + std::vector parseInto( int argc, char const* argv[], ConfigT& config ) const { + std::string processName = argv[0]; + std::size_t lastSlash = processName.find_last_of( "/\\" ); + if( lastSlash != std::string::npos ) + processName = processName.substr( lastSlash+1 ); + m_boundProcessName.set( config, processName ); + std::vector tokens; + Parser parser; + parser.parseIntoTokens( argc, argv, tokens ); + return populate( tokens, config ); + } + + std::vector populate( std::vector const& tokens, ConfigT& config ) const { + validate(); + std::vector unusedTokens = populateOptions( tokens, config ); + unusedTokens = populateFixedArgs( unusedTokens, config ); + unusedTokens = populateFloatingArgs( unusedTokens, config ); + return unusedTokens; + } + + std::vector populateOptions( std::vector const& tokens, ConfigT& config ) const { + std::vector unusedTokens; + std::vector errors; + for( std::size_t i = 0; i < tokens.size(); ++i ) { + Parser::Token const& token = tokens[i]; + typename std::vector::const_iterator it = m_options.begin(), itEnd = m_options.end(); + for(; it != itEnd; ++it ) { + Arg const& arg = *it; + + try { + if( ( token.type == Parser::Token::ShortOpt && arg.hasShortName( token.data ) ) || + ( token.type == Parser::Token::LongOpt && arg.hasLongName( token.data ) ) ) { + if( arg.takesArg() ) { + if( i == tokens.size()-1 || tokens[i+1].type != Parser::Token::Positional ) + errors.push_back( "Expected argument to option: " + token.data ); + else + arg.boundField.set( config, tokens[++i].data ); + } + else { + arg.boundField.setFlag( config ); + } + break; + } + } + catch( std::exception& ex ) { + errors.push_back( std::string( ex.what() ) + "\n- while parsing: (" + arg.commands() + ")" ); + } + } + if( it == itEnd ) { + if( token.type == Parser::Token::Positional || !m_throwOnUnrecognisedTokens ) + unusedTokens.push_back( token ); + else if( errors.empty() && m_throwOnUnrecognisedTokens ) + errors.push_back( "unrecognised option: " + token.data ); + } + } + if( !errors.empty() ) { + std::ostringstream oss; + for( std::vector::const_iterator it = errors.begin(), itEnd = errors.end(); + it != itEnd; + ++it ) { + if( it != errors.begin() ) + oss << "\n"; + oss << *it; + } + throw std::runtime_error( oss.str() ); + } + return unusedTokens; + } + std::vector populateFixedArgs( std::vector const& tokens, ConfigT& config ) const { + std::vector unusedTokens; + int position = 1; + for( std::size_t i = 0; i < tokens.size(); ++i ) { + Parser::Token const& token = tokens[i]; + typename std::map::const_iterator it = m_positionalArgs.find( position ); + if( it != m_positionalArgs.end() ) + it->second.boundField.set( config, token.data ); + else + unusedTokens.push_back( token ); + if( token.type == Parser::Token::Positional ) + position++; + } + return unusedTokens; + } + std::vector populateFloatingArgs( std::vector const& tokens, ConfigT& config ) const { + if( !m_floatingArg.get() ) + return tokens; + std::vector unusedTokens; + for( std::size_t i = 0; i < tokens.size(); ++i ) { + Parser::Token const& token = tokens[i]; + if( token.type == Parser::Token::Positional ) + m_floatingArg->boundField.set( config, token.data ); + else + unusedTokens.push_back( token ); + } + return unusedTokens; + } + + void validate() const + { + if( m_options.empty() && m_positionalArgs.empty() && !m_floatingArg.get() ) + throw std::logic_error( "No options or arguments specified" ); + + for( typename std::vector::const_iterator it = m_options.begin(), + itEnd = m_options.end(); + it != itEnd; ++it ) + it->validate(); + } + + private: + Detail::BoundArgFunction m_boundProcessName; + std::vector m_options; + std::map m_positionalArgs; + ArgAutoPtr m_floatingArg; + int m_highestSpecifiedArgPosition; + bool m_throwOnUnrecognisedTokens; + }; + +} // end namespace Clara + +STITCH_CLARA_CLOSE_NAMESPACE +#undef STITCH_CLARA_OPEN_NAMESPACE +#undef STITCH_CLARA_CLOSE_NAMESPACE + +#endif // TWOBLUECUBES_CLARA_H_INCLUDED +#undef STITCH_CLARA_OPEN_NAMESPACE + +// Restore Clara's value for console width, if present +#ifdef CATCH_TEMP_CLARA_CONFIG_CONSOLE_WIDTH +#define CLARA_CONFIG_CONSOLE_WIDTH CATCH_TEMP_CLARA_CONFIG_CONSOLE_WIDTH +#undef CATCH_TEMP_CLARA_CONFIG_CONSOLE_WIDTH +#endif + +#include + +namespace Catch { + + inline void abortAfterFirst( ConfigData& config ) { config.abortAfter = 1; } + inline void abortAfterX( ConfigData& config, int x ) { + if( x < 1 ) + throw std::runtime_error( "Value after -x or --abortAfter must be greater than zero" ); + config.abortAfter = x; + } + inline void addTestOrTags( ConfigData& config, std::string const& _testSpec ) { config.testsOrTags.push_back( _testSpec ); } + inline void addReporterName( ConfigData& config, std::string const& _reporterName ) { config.reporterNames.push_back( _reporterName ); } + + inline void addWarning( ConfigData& config, std::string const& _warning ) { + if( _warning == "NoAssertions" ) + config.warnings = static_cast( config.warnings | WarnAbout::NoAssertions ); + else + throw std::runtime_error( "Unrecognised warning: '" + _warning + "'" ); + } + inline void setOrder( ConfigData& config, std::string const& order ) { + if( startsWith( "declared", order ) ) + config.runOrder = RunTests::InDeclarationOrder; + else if( startsWith( "lexical", order ) ) + config.runOrder = RunTests::InLexicographicalOrder; + else if( startsWith( "random", order ) ) + config.runOrder = RunTests::InRandomOrder; + else + throw std::runtime_error( "Unrecognised ordering: '" + order + "'" ); + } + inline void setRngSeed( ConfigData& config, std::string const& seed ) { + if( seed == "time" ) { + config.rngSeed = static_cast( std::time(0) ); + } + else { + std::stringstream ss; + ss << seed; + ss >> config.rngSeed; + if( ss.fail() ) + throw std::runtime_error( "Argment to --rng-seed should be the word 'time' or a number" ); + } + } + inline void setVerbosity( ConfigData& config, int level ) { + // !TBD: accept strings? + config.verbosity = static_cast( level ); + } + inline void setShowDurations( ConfigData& config, bool _showDurations ) { + config.showDurations = _showDurations + ? ShowDurations::Always + : ShowDurations::Never; + } + inline void setUseColour( ConfigData& config, std::string const& value ) { + std::string mode = toLower( value ); + + if( mode == "yes" ) + config.useColour = UseColour::Yes; + else if( mode == "no" ) + config.useColour = UseColour::No; + else if( mode == "auto" ) + config.useColour = UseColour::Auto; + else + throw std::runtime_error( "colour mode must be one of: auto, yes or no" ); + } + inline void forceColour( ConfigData& config ) { + config.useColour = UseColour::Yes; + } + inline void loadTestNamesFromFile( ConfigData& config, std::string const& _filename ) { + std::ifstream f( _filename.c_str() ); + if( !f.is_open() ) + throw std::domain_error( "Unable to load input file: " + _filename ); + + std::string line; + while( std::getline( f, line ) ) { + line = trim(line); + if( !line.empty() && !startsWith( line, "#" ) ) + addTestOrTags( config, "\"" + line + "\"," ); + } + } + + inline Clara::CommandLine makeCommandLineParser() { + + using namespace Clara; + CommandLine cli; + + cli.bindProcessName( &ConfigData::processName ); + + cli["-?"]["-h"]["--help"] + .describe( "display usage information" ) + .bind( &ConfigData::showHelp ); + + cli["-l"]["--list-tests"] + .describe( "list all/matching test cases" ) + .bind( &ConfigData::listTests ); + + cli["-t"]["--list-tags"] + .describe( "list all/matching tags" ) + .bind( &ConfigData::listTags ); + + cli["-s"]["--success"] + .describe( "include successful tests in output" ) + .bind( &ConfigData::showSuccessfulTests ); + + cli["-b"]["--break"] + .describe( "break into debugger on failure" ) + .bind( &ConfigData::shouldDebugBreak ); + + cli["-e"]["--nothrow"] + .describe( "skip exception tests" ) + .bind( &ConfigData::noThrow ); + + cli["-i"]["--invisibles"] + .describe( "show invisibles (tabs, newlines)" ) + .bind( &ConfigData::showInvisibles ); + + cli["-o"]["--out"] + .describe( "output filename" ) + .bind( &ConfigData::outputFilename, "filename" ); + + cli["-r"]["--reporter"] +// .placeholder( "name[:filename]" ) + .describe( "reporter to use (defaults to console)" ) + .bind( &addReporterName, "name" ); + + cli["-n"]["--name"] + .describe( "suite name" ) + .bind( &ConfigData::name, "name" ); + + cli["-a"]["--abort"] + .describe( "abort at first failure" ) + .bind( &abortAfterFirst ); + + cli["-x"]["--abortx"] + .describe( "abort after x failures" ) + .bind( &abortAfterX, "no. failures" ); + + cli["-w"]["--warn"] + .describe( "enable warnings" ) + .bind( &addWarning, "warning name" ); + +// - needs updating if reinstated +// cli.into( &setVerbosity ) +// .describe( "level of verbosity (0=no output)" ) +// .shortOpt( "v") +// .longOpt( "verbosity" ) +// .placeholder( "level" ); + + cli[_] + .describe( "which test or tests to use" ) + .bind( &addTestOrTags, "test name, pattern or tags" ); + + cli["-d"]["--durations"] + .describe( "show test durations" ) + .bind( &setShowDurations, "yes|no" ); + + cli["-f"]["--input-file"] + .describe( "load test names to run from a file" ) + .bind( &loadTestNamesFromFile, "filename" ); + + cli["-#"]["--filenames-as-tags"] + .describe( "adds a tag for the filename" ) + .bind( &ConfigData::filenamesAsTags ); + + // Less common commands which don't have a short form + cli["--list-test-names-only"] + .describe( "list all/matching test cases names only" ) + .bind( &ConfigData::listTestNamesOnly ); + + cli["--list-reporters"] + .describe( "list all reporters" ) + .bind( &ConfigData::listReporters ); + + cli["--order"] + .describe( "test case order (defaults to decl)" ) + .bind( &setOrder, "decl|lex|rand" ); + + cli["--rng-seed"] + .describe( "set a specific seed for random numbers" ) + .bind( &setRngSeed, "'time'|number" ); + + cli["--force-colour"] + .describe( "force colourised output (deprecated)" ) + .bind( &forceColour ); + + cli["--use-colour"] + .describe( "should output be colourised" ) + .bind( &setUseColour, "yes|no" ); + + return cli; + } + +} // end namespace Catch + +// #included from: internal/catch_list.hpp +#define TWOBLUECUBES_CATCH_LIST_HPP_INCLUDED + +// #included from: catch_text.h +#define TWOBLUECUBES_CATCH_TEXT_H_INCLUDED + +#define TBC_TEXT_FORMAT_CONSOLE_WIDTH CATCH_CONFIG_CONSOLE_WIDTH + +#define CLICHE_TBC_TEXT_FORMAT_OUTER_NAMESPACE Catch +// #included from: ../external/tbc_text_format.h +// Only use header guard if we are not using an outer namespace +#ifndef CLICHE_TBC_TEXT_FORMAT_OUTER_NAMESPACE +# ifdef TWOBLUECUBES_TEXT_FORMAT_H_INCLUDED +# ifndef TWOBLUECUBES_TEXT_FORMAT_H_ALREADY_INCLUDED +# define TWOBLUECUBES_TEXT_FORMAT_H_ALREADY_INCLUDED +# endif +# else +# define TWOBLUECUBES_TEXT_FORMAT_H_INCLUDED +# endif +#endif +#ifndef TWOBLUECUBES_TEXT_FORMAT_H_ALREADY_INCLUDED +#include +#include +#include + +// Use optional outer namespace +#ifdef CLICHE_TBC_TEXT_FORMAT_OUTER_NAMESPACE +namespace CLICHE_TBC_TEXT_FORMAT_OUTER_NAMESPACE { +#endif + +namespace Tbc { + +#ifdef TBC_TEXT_FORMAT_CONSOLE_WIDTH + const unsigned int consoleWidth = TBC_TEXT_FORMAT_CONSOLE_WIDTH; +#else + const unsigned int consoleWidth = 80; +#endif + + struct TextAttributes { + TextAttributes() + : initialIndent( std::string::npos ), + indent( 0 ), + width( consoleWidth-1 ), + tabChar( '\t' ) + {} + + TextAttributes& setInitialIndent( std::size_t _value ) { initialIndent = _value; return *this; } + TextAttributes& setIndent( std::size_t _value ) { indent = _value; return *this; } + TextAttributes& setWidth( std::size_t _value ) { width = _value; return *this; } + TextAttributes& setTabChar( char _value ) { tabChar = _value; return *this; } + + std::size_t initialIndent; // indent of first line, or npos + std::size_t indent; // indent of subsequent lines, or all if initialIndent is npos + std::size_t width; // maximum width of text, including indent. Longer text will wrap + char tabChar; // If this char is seen the indent is changed to current pos + }; + + class Text { + public: + Text( std::string const& _str, TextAttributes const& _attr = TextAttributes() ) + : attr( _attr ) + { + std::string wrappableChars = " [({.,/|\\-"; + std::size_t indent = _attr.initialIndent != std::string::npos + ? _attr.initialIndent + : _attr.indent; + std::string remainder = _str; + + while( !remainder.empty() ) { + if( lines.size() >= 1000 ) { + lines.push_back( "... message truncated due to excessive size" ); + return; + } + std::size_t tabPos = std::string::npos; + std::size_t width = (std::min)( remainder.size(), _attr.width - indent ); + std::size_t pos = remainder.find_first_of( '\n' ); + if( pos <= width ) { + width = pos; + } + pos = remainder.find_last_of( _attr.tabChar, width ); + if( pos != std::string::npos ) { + tabPos = pos; + if( remainder[width] == '\n' ) + width--; + remainder = remainder.substr( 0, tabPos ) + remainder.substr( tabPos+1 ); + } + + if( width == remainder.size() ) { + spliceLine( indent, remainder, width ); + } + else if( remainder[width] == '\n' ) { + spliceLine( indent, remainder, width ); + if( width <= 1 || remainder.size() != 1 ) + remainder = remainder.substr( 1 ); + indent = _attr.indent; + } + else { + pos = remainder.find_last_of( wrappableChars, width ); + if( pos != std::string::npos && pos > 0 ) { + spliceLine( indent, remainder, pos ); + if( remainder[0] == ' ' ) + remainder = remainder.substr( 1 ); + } + else { + spliceLine( indent, remainder, width-1 ); + lines.back() += "-"; + } + if( lines.size() == 1 ) + indent = _attr.indent; + if( tabPos != std::string::npos ) + indent += tabPos; + } + } + } + + void spliceLine( std::size_t _indent, std::string& _remainder, std::size_t _pos ) { + lines.push_back( std::string( _indent, ' ' ) + _remainder.substr( 0, _pos ) ); + _remainder = _remainder.substr( _pos ); + } + + typedef std::vector::const_iterator const_iterator; + + const_iterator begin() const { return lines.begin(); } + const_iterator end() const { return lines.end(); } + std::string const& last() const { return lines.back(); } + std::size_t size() const { return lines.size(); } + std::string const& operator[]( std::size_t _index ) const { return lines[_index]; } + std::string toString() const { + std::ostringstream oss; + oss << *this; + return oss.str(); + } + + inline friend std::ostream& operator << ( std::ostream& _stream, Text const& _text ) { + for( Text::const_iterator it = _text.begin(), itEnd = _text.end(); + it != itEnd; ++it ) { + if( it != _text.begin() ) + _stream << "\n"; + _stream << *it; + } + return _stream; + } + + private: + std::string str; + TextAttributes attr; + std::vector lines; + }; + +} // end namespace Tbc + +#ifdef CLICHE_TBC_TEXT_FORMAT_OUTER_NAMESPACE +} // end outer namespace +#endif + +#endif // TWOBLUECUBES_TEXT_FORMAT_H_ALREADY_INCLUDED +#undef CLICHE_TBC_TEXT_FORMAT_OUTER_NAMESPACE + +namespace Catch { + using Tbc::Text; + using Tbc::TextAttributes; +} + +// #included from: catch_console_colour.hpp +#define TWOBLUECUBES_CATCH_CONSOLE_COLOUR_HPP_INCLUDED + +namespace Catch { + + struct Colour { + enum Code { + None = 0, + + White, + Red, + Green, + Blue, + Cyan, + Yellow, + Grey, + + Bright = 0x10, + + BrightRed = Bright | Red, + BrightGreen = Bright | Green, + LightGrey = Bright | Grey, + BrightWhite = Bright | White, + + // By intention + FileName = LightGrey, + Warning = Yellow, + ResultError = BrightRed, + ResultSuccess = BrightGreen, + ResultExpectedFailure = Warning, + + Error = BrightRed, + Success = Green, + + OriginalExpression = Cyan, + ReconstructedExpression = Yellow, + + SecondaryText = LightGrey, + Headers = White + }; + + // Use constructed object for RAII guard + Colour( Code _colourCode ); + Colour( Colour const& other ); + ~Colour(); + + // Use static method for one-shot changes + static void use( Code _colourCode ); + + private: + bool m_moved; + }; + + inline std::ostream& operator << ( std::ostream& os, Colour const& ) { return os; } + +} // end namespace Catch + +// #included from: catch_interfaces_reporter.h +#define TWOBLUECUBES_CATCH_INTERFACES_REPORTER_H_INCLUDED + +#include +#include +#include +#include + +namespace Catch +{ + struct ReporterConfig { + explicit ReporterConfig( Ptr const& _fullConfig ) + : m_stream( &_fullConfig->stream() ), m_fullConfig( _fullConfig ) {} + + ReporterConfig( Ptr const& _fullConfig, std::ostream& _stream ) + : m_stream( &_stream ), m_fullConfig( _fullConfig ) {} + + std::ostream& stream() const { return *m_stream; } + Ptr fullConfig() const { return m_fullConfig; } + + private: + std::ostream* m_stream; + Ptr m_fullConfig; + }; + + struct ReporterPreferences { + ReporterPreferences() + : shouldRedirectStdOut( false ) + {} + + bool shouldRedirectStdOut; + }; + + template + struct LazyStat : Option { + LazyStat() : used( false ) {} + LazyStat& operator=( T const& _value ) { + Option::operator=( _value ); + used = false; + return *this; + } + void reset() { + Option::reset(); + used = false; + } + bool used; + }; + + struct TestRunInfo { + TestRunInfo( std::string const& _name ) : name( _name ) {} + std::string name; + }; + struct GroupInfo { + GroupInfo( std::string const& _name, + std::size_t _groupIndex, + std::size_t _groupsCount ) + : name( _name ), + groupIndex( _groupIndex ), + groupsCounts( _groupsCount ) + {} + + std::string name; + std::size_t groupIndex; + std::size_t groupsCounts; + }; + + struct AssertionStats { + AssertionStats( AssertionResult const& _assertionResult, + std::vector const& _infoMessages, + Totals const& _totals ) + : assertionResult( _assertionResult ), + infoMessages( _infoMessages ), + totals( _totals ) + { + if( assertionResult.hasMessage() ) { + // Copy message into messages list. + // !TBD This should have been done earlier, somewhere + MessageBuilder builder( assertionResult.getTestMacroName(), assertionResult.getSourceInfo(), assertionResult.getResultType() ); + builder << assertionResult.getMessage(); + builder.m_info.message = builder.m_stream.str(); + + infoMessages.push_back( builder.m_info ); + } + } + virtual ~AssertionStats(); + +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + AssertionStats( AssertionStats const& ) = default; + AssertionStats( AssertionStats && ) = default; + AssertionStats& operator = ( AssertionStats const& ) = default; + AssertionStats& operator = ( AssertionStats && ) = default; +# endif + + AssertionResult assertionResult; + std::vector infoMessages; + Totals totals; + }; + + struct SectionStats { + SectionStats( SectionInfo const& _sectionInfo, + Counts const& _assertions, + double _durationInSeconds, + bool _missingAssertions ) + : sectionInfo( _sectionInfo ), + assertions( _assertions ), + durationInSeconds( _durationInSeconds ), + missingAssertions( _missingAssertions ) + {} + virtual ~SectionStats(); +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + SectionStats( SectionStats const& ) = default; + SectionStats( SectionStats && ) = default; + SectionStats& operator = ( SectionStats const& ) = default; + SectionStats& operator = ( SectionStats && ) = default; +# endif + + SectionInfo sectionInfo; + Counts assertions; + double durationInSeconds; + bool missingAssertions; + }; + + struct TestCaseStats { + TestCaseStats( TestCaseInfo const& _testInfo, + Totals const& _totals, + std::string const& _stdOut, + std::string const& _stdErr, + bool _aborting ) + : testInfo( _testInfo ), + totals( _totals ), + stdOut( _stdOut ), + stdErr( _stdErr ), + aborting( _aborting ) + {} + virtual ~TestCaseStats(); + +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + TestCaseStats( TestCaseStats const& ) = default; + TestCaseStats( TestCaseStats && ) = default; + TestCaseStats& operator = ( TestCaseStats const& ) = default; + TestCaseStats& operator = ( TestCaseStats && ) = default; +# endif + + TestCaseInfo testInfo; + Totals totals; + std::string stdOut; + std::string stdErr; + bool aborting; + }; + + struct TestGroupStats { + TestGroupStats( GroupInfo const& _groupInfo, + Totals const& _totals, + bool _aborting ) + : groupInfo( _groupInfo ), + totals( _totals ), + aborting( _aborting ) + {} + TestGroupStats( GroupInfo const& _groupInfo ) + : groupInfo( _groupInfo ), + aborting( false ) + {} + virtual ~TestGroupStats(); + +# ifdef CATCH_CONFIG_CPP11_GENERATED_METHODS + TestGroupStats( TestGroupStats const& ) = default; + TestGroupStats( TestGroupStats && ) = default; + TestGroupStats& operator = ( TestGroupStats const& ) = default; + TestGroupStats& operator = ( TestGroupStats && ) = default; +# endif + + GroupInfo groupInfo; + Totals totals; + bool aborting; + }; + + struct TestRunStats { + TestRunStats( TestRunInfo const& _runInfo, + Totals const& _totals, + bool _aborting ) + : runInfo( _runInfo ), + totals( _totals ), + aborting( _aborting ) + {} + virtual ~TestRunStats(); + +# ifndef CATCH_CONFIG_CPP11_GENERATED_METHODS + TestRunStats( TestRunStats const& _other ) + : runInfo( _other.runInfo ), + totals( _other.totals ), + aborting( _other.aborting ) + {} +# else + TestRunStats( TestRunStats const& ) = default; + TestRunStats( TestRunStats && ) = default; + TestRunStats& operator = ( TestRunStats const& ) = default; + TestRunStats& operator = ( TestRunStats && ) = default; +# endif + + TestRunInfo runInfo; + Totals totals; + bool aborting; + }; + + struct IStreamingReporter : IShared { + virtual ~IStreamingReporter(); + + // Implementing class must also provide the following static method: + // static std::string getDescription(); + + virtual ReporterPreferences getPreferences() const = 0; + + virtual void noMatchingTestCases( std::string const& spec ) = 0; + + virtual void testRunStarting( TestRunInfo const& testRunInfo ) = 0; + virtual void testGroupStarting( GroupInfo const& groupInfo ) = 0; + + virtual void testCaseStarting( TestCaseInfo const& testInfo ) = 0; + virtual void sectionStarting( SectionInfo const& sectionInfo ) = 0; + + virtual void assertionStarting( AssertionInfo const& assertionInfo ) = 0; + + // The return value indicates if the messages buffer should be cleared: + virtual bool assertionEnded( AssertionStats const& assertionStats ) = 0; + + virtual void sectionEnded( SectionStats const& sectionStats ) = 0; + virtual void testCaseEnded( TestCaseStats const& testCaseStats ) = 0; + virtual void testGroupEnded( TestGroupStats const& testGroupStats ) = 0; + virtual void testRunEnded( TestRunStats const& testRunStats ) = 0; + + virtual void skipTest( TestCaseInfo const& testInfo ) = 0; + }; + + struct IReporterFactory : IShared { + virtual ~IReporterFactory(); + virtual IStreamingReporter* create( ReporterConfig const& config ) const = 0; + virtual std::string getDescription() const = 0; + }; + + struct IReporterRegistry { + typedef std::map > FactoryMap; + typedef std::vector > Listeners; + + virtual ~IReporterRegistry(); + virtual IStreamingReporter* create( std::string const& name, Ptr const& config ) const = 0; + virtual FactoryMap const& getFactories() const = 0; + virtual Listeners const& getListeners() const = 0; + }; + + Ptr addReporter( Ptr const& existingReporter, Ptr const& additionalReporter ); + +} + +#include +#include + +namespace Catch { + + inline std::size_t listTests( Config const& config ) { + + TestSpec testSpec = config.testSpec(); + if( config.testSpec().hasFilters() ) + Catch::cout() << "Matching test cases:\n"; + else { + Catch::cout() << "All available test cases:\n"; + testSpec = TestSpecParser( ITagAliasRegistry::get() ).parse( "*" ).testSpec(); + } + + std::size_t matchedTests = 0; + TextAttributes nameAttr, tagsAttr; + nameAttr.setInitialIndent( 2 ).setIndent( 4 ); + tagsAttr.setIndent( 6 ); + + std::vector matchedTestCases = filterTests( getAllTestCasesSorted( config ), testSpec, config ); + for( std::vector::const_iterator it = matchedTestCases.begin(), itEnd = matchedTestCases.end(); + it != itEnd; + ++it ) { + matchedTests++; + TestCaseInfo const& testCaseInfo = it->getTestCaseInfo(); + Colour::Code colour = testCaseInfo.isHidden() + ? Colour::SecondaryText + : Colour::None; + Colour colourGuard( colour ); + + Catch::cout() << Text( testCaseInfo.name, nameAttr ) << std::endl; + if( !testCaseInfo.tags.empty() ) + Catch::cout() << Text( testCaseInfo.tagsAsString, tagsAttr ) << std::endl; + } + + if( !config.testSpec().hasFilters() ) + Catch::cout() << pluralise( matchedTests, "test case" ) << "\n" << std::endl; + else + Catch::cout() << pluralise( matchedTests, "matching test case" ) << "\n" << std::endl; + return matchedTests; + } + + inline std::size_t listTestsNamesOnly( Config const& config ) { + TestSpec testSpec = config.testSpec(); + if( !config.testSpec().hasFilters() ) + testSpec = TestSpecParser( ITagAliasRegistry::get() ).parse( "*" ).testSpec(); + std::size_t matchedTests = 0; + std::vector matchedTestCases = filterTests( getAllTestCasesSorted( config ), testSpec, config ); + for( std::vector::const_iterator it = matchedTestCases.begin(), itEnd = matchedTestCases.end(); + it != itEnd; + ++it ) { + matchedTests++; + TestCaseInfo const& testCaseInfo = it->getTestCaseInfo(); + Catch::cout() << testCaseInfo.name << std::endl; + } + return matchedTests; + } + + struct TagInfo { + TagInfo() : count ( 0 ) {} + void add( std::string const& spelling ) { + ++count; + spellings.insert( spelling ); + } + std::string all() const { + std::string out; + for( std::set::const_iterator it = spellings.begin(), itEnd = spellings.end(); + it != itEnd; + ++it ) + out += "[" + *it + "]"; + return out; + } + std::set spellings; + std::size_t count; + }; + + inline std::size_t listTags( Config const& config ) { + TestSpec testSpec = config.testSpec(); + if( config.testSpec().hasFilters() ) + Catch::cout() << "Tags for matching test cases:\n"; + else { + Catch::cout() << "All available tags:\n"; + testSpec = TestSpecParser( ITagAliasRegistry::get() ).parse( "*" ).testSpec(); + } + + std::map tagCounts; + + std::vector matchedTestCases = filterTests( getAllTestCasesSorted( config ), testSpec, config ); + for( std::vector::const_iterator it = matchedTestCases.begin(), itEnd = matchedTestCases.end(); + it != itEnd; + ++it ) { + for( std::set::const_iterator tagIt = it->getTestCaseInfo().tags.begin(), + tagItEnd = it->getTestCaseInfo().tags.end(); + tagIt != tagItEnd; + ++tagIt ) { + std::string tagName = *tagIt; + std::string lcaseTagName = toLower( tagName ); + std::map::iterator countIt = tagCounts.find( lcaseTagName ); + if( countIt == tagCounts.end() ) + countIt = tagCounts.insert( std::make_pair( lcaseTagName, TagInfo() ) ).first; + countIt->second.add( tagName ); + } + } + + for( std::map::const_iterator countIt = tagCounts.begin(), + countItEnd = tagCounts.end(); + countIt != countItEnd; + ++countIt ) { + std::ostringstream oss; + oss << " " << std::setw(2) << countIt->second.count << " "; + Text wrapper( countIt->second.all(), TextAttributes() + .setInitialIndent( 0 ) + .setIndent( oss.str().size() ) + .setWidth( CATCH_CONFIG_CONSOLE_WIDTH-10 ) ); + Catch::cout() << oss.str() << wrapper << "\n"; + } + Catch::cout() << pluralise( tagCounts.size(), "tag" ) << "\n" << std::endl; + return tagCounts.size(); + } + + inline std::size_t listReporters( Config const& /*config*/ ) { + Catch::cout() << "Available reporters:\n"; + IReporterRegistry::FactoryMap const& factories = getRegistryHub().getReporterRegistry().getFactories(); + IReporterRegistry::FactoryMap::const_iterator itBegin = factories.begin(), itEnd = factories.end(), it; + std::size_t maxNameLen = 0; + for(it = itBegin; it != itEnd; ++it ) + maxNameLen = (std::max)( maxNameLen, it->first.size() ); + + for(it = itBegin; it != itEnd; ++it ) { + Text wrapper( it->second->getDescription(), TextAttributes() + .setInitialIndent( 0 ) + .setIndent( 7+maxNameLen ) + .setWidth( CATCH_CONFIG_CONSOLE_WIDTH - maxNameLen-8 ) ); + Catch::cout() << " " + << it->first + << ":" + << std::string( maxNameLen - it->first.size() + 2, ' ' ) + << wrapper << "\n"; + } + Catch::cout() << std::endl; + return factories.size(); + } + + inline Option list( Config const& config ) { + Option listedCount; + if( config.listTests() ) + listedCount = listedCount.valueOr(0) + listTests( config ); + if( config.listTestNamesOnly() ) + listedCount = listedCount.valueOr(0) + listTestsNamesOnly( config ); + if( config.listTags() ) + listedCount = listedCount.valueOr(0) + listTags( config ); + if( config.listReporters() ) + listedCount = listedCount.valueOr(0) + listReporters( config ); + return listedCount; + } + +} // end namespace Catch + +// #included from: internal/catch_run_context.hpp +#define TWOBLUECUBES_CATCH_RUNNER_IMPL_HPP_INCLUDED + +// #included from: catch_test_case_tracker.hpp +#define TWOBLUECUBES_CATCH_TEST_CASE_TRACKER_HPP_INCLUDED + +#include +#include +#include +#include + +namespace Catch { +namespace TestCaseTracking { + + struct ITracker : SharedImpl<> { + virtual ~ITracker(); + + // static queries + virtual std::string name() const = 0; + + // dynamic queries + virtual bool isComplete() const = 0; // Successfully completed or failed + virtual bool isSuccessfullyCompleted() const = 0; + virtual bool isOpen() const = 0; // Started but not complete + virtual bool hasChildren() const = 0; + + virtual ITracker& parent() = 0; + + // actions + virtual void close() = 0; // Successfully complete + virtual void fail() = 0; + virtual void markAsNeedingAnotherRun() = 0; + + virtual void addChild( Ptr const& child ) = 0; + virtual ITracker* findChild( std::string const& name ) = 0; + virtual void openChild() = 0; + }; + + class TrackerContext { + + enum RunState { + NotStarted, + Executing, + CompletedCycle + }; + + Ptr m_rootTracker; + ITracker* m_currentTracker; + RunState m_runState; + + public: + + static TrackerContext& instance() { + static TrackerContext s_instance; + return s_instance; + } + + TrackerContext() + : m_currentTracker( CATCH_NULL ), + m_runState( NotStarted ) + {} + + ITracker& startRun(); + + void endRun() { + m_rootTracker.reset(); + m_currentTracker = CATCH_NULL; + m_runState = NotStarted; + } + + void startCycle() { + m_currentTracker = m_rootTracker.get(); + m_runState = Executing; + } + void completeCycle() { + m_runState = CompletedCycle; + } + + bool completedCycle() const { + return m_runState == CompletedCycle; + } + ITracker& currentTracker() { + return *m_currentTracker; + } + void setCurrentTracker( ITracker* tracker ) { + m_currentTracker = tracker; + } + }; + + class TrackerBase : public ITracker { + protected: + enum CycleState { + NotStarted, + Executing, + ExecutingChildren, + NeedsAnotherRun, + CompletedSuccessfully, + Failed + }; + class TrackerHasName { + std::string m_name; + public: + TrackerHasName( std::string const& name ) : m_name( name ) {} + bool operator ()( Ptr const& tracker ) { + return tracker->name() == m_name; + } + }; + typedef std::vector > Children; + std::string m_name; + TrackerContext& m_ctx; + ITracker* m_parent; + Children m_children; + CycleState m_runState; + public: + TrackerBase( std::string const& name, TrackerContext& ctx, ITracker* parent ) + : m_name( name ), + m_ctx( ctx ), + m_parent( parent ), + m_runState( NotStarted ) + {} + virtual ~TrackerBase(); + + virtual std::string name() const CATCH_OVERRIDE { + return m_name; + } + virtual bool isComplete() const CATCH_OVERRIDE { + return m_runState == CompletedSuccessfully || m_runState == Failed; + } + virtual bool isSuccessfullyCompleted() const CATCH_OVERRIDE { + return m_runState == CompletedSuccessfully; + } + virtual bool isOpen() const CATCH_OVERRIDE { + return m_runState != NotStarted && !isComplete(); + } + virtual bool hasChildren() const CATCH_OVERRIDE { + return !m_children.empty(); + } + + virtual void addChild( Ptr const& child ) CATCH_OVERRIDE { + m_children.push_back( child ); + } + + virtual ITracker* findChild( std::string const& name ) CATCH_OVERRIDE { + Children::const_iterator it = std::find_if( m_children.begin(), m_children.end(), TrackerHasName( name ) ); + return( it != m_children.end() ) + ? it->get() + : CATCH_NULL; + } + virtual ITracker& parent() CATCH_OVERRIDE { + assert( m_parent ); // Should always be non-null except for root + return *m_parent; + } + + virtual void openChild() CATCH_OVERRIDE { + if( m_runState != ExecutingChildren ) { + m_runState = ExecutingChildren; + if( m_parent ) + m_parent->openChild(); + } + } + void open() { + m_runState = Executing; + moveToThis(); + if( m_parent ) + m_parent->openChild(); + } + + virtual void close() CATCH_OVERRIDE { + + // Close any still open children (e.g. generators) + while( &m_ctx.currentTracker() != this ) + m_ctx.currentTracker().close(); + + switch( m_runState ) { + case NotStarted: + case CompletedSuccessfully: + case Failed: + throw std::logic_error( "Illogical state" ); + + case NeedsAnotherRun: + break;; + + case Executing: + m_runState = CompletedSuccessfully; + break; + case ExecutingChildren: + if( m_children.empty() || m_children.back()->isComplete() ) + m_runState = CompletedSuccessfully; + break; + + default: + throw std::logic_error( "Unexpected state" ); + } + moveToParent(); + m_ctx.completeCycle(); + } + virtual void fail() CATCH_OVERRIDE { + m_runState = Failed; + if( m_parent ) + m_parent->markAsNeedingAnotherRun(); + moveToParent(); + m_ctx.completeCycle(); + } + virtual void markAsNeedingAnotherRun() CATCH_OVERRIDE { + m_runState = NeedsAnotherRun; + } + private: + void moveToParent() { + assert( m_parent ); + m_ctx.setCurrentTracker( m_parent ); + } + void moveToThis() { + m_ctx.setCurrentTracker( this ); + } + }; + + class SectionTracker : public TrackerBase { + public: + SectionTracker( std::string const& name, TrackerContext& ctx, ITracker* parent ) + : TrackerBase( name, ctx, parent ) + {} + virtual ~SectionTracker(); + + static SectionTracker& acquire( TrackerContext& ctx, std::string const& name ) { + SectionTracker* section = CATCH_NULL; + + ITracker& currentTracker = ctx.currentTracker(); + if( ITracker* childTracker = currentTracker.findChild( name ) ) { + section = dynamic_cast( childTracker ); + assert( section ); + } + else { + section = new SectionTracker( name, ctx, ¤tTracker ); + currentTracker.addChild( section ); + } + if( !ctx.completedCycle() && !section->isComplete() ) { + + section->open(); + } + return *section; + } + }; + + class IndexTracker : public TrackerBase { + int m_size; + int m_index; + public: + IndexTracker( std::string const& name, TrackerContext& ctx, ITracker* parent, int size ) + : TrackerBase( name, ctx, parent ), + m_size( size ), + m_index( -1 ) + {} + virtual ~IndexTracker(); + + static IndexTracker& acquire( TrackerContext& ctx, std::string const& name, int size ) { + IndexTracker* tracker = CATCH_NULL; + + ITracker& currentTracker = ctx.currentTracker(); + if( ITracker* childTracker = currentTracker.findChild( name ) ) { + tracker = dynamic_cast( childTracker ); + assert( tracker ); + } + else { + tracker = new IndexTracker( name, ctx, ¤tTracker, size ); + currentTracker.addChild( tracker ); + } + + if( !ctx.completedCycle() && !tracker->isComplete() ) { + if( tracker->m_runState != ExecutingChildren && tracker->m_runState != NeedsAnotherRun ) + tracker->moveNext(); + tracker->open(); + } + + return *tracker; + } + + int index() const { return m_index; } + + void moveNext() { + m_index++; + m_children.clear(); + } + + virtual void close() CATCH_OVERRIDE { + TrackerBase::close(); + if( m_runState == CompletedSuccessfully && m_index < m_size-1 ) + m_runState = Executing; + } + }; + + inline ITracker& TrackerContext::startRun() { + m_rootTracker = new SectionTracker( "{root}", *this, CATCH_NULL ); + m_currentTracker = CATCH_NULL; + m_runState = Executing; + return *m_rootTracker; + } + +} // namespace TestCaseTracking + +using TestCaseTracking::ITracker; +using TestCaseTracking::TrackerContext; +using TestCaseTracking::SectionTracker; +using TestCaseTracking::IndexTracker; + +} // namespace Catch + +// #included from: catch_fatal_condition.hpp +#define TWOBLUECUBES_CATCH_FATAL_CONDITION_H_INCLUDED + +namespace Catch { + + // Report the error condition then exit the process + inline void fatal( std::string const& message, int exitCode ) { + IContext& context = Catch::getCurrentContext(); + IResultCapture* resultCapture = context.getResultCapture(); + resultCapture->handleFatalErrorCondition( message ); + + if( Catch::alwaysTrue() ) // avoids "no return" warnings + exit( exitCode ); + } + +} // namespace Catch + +#if defined ( CATCH_PLATFORM_WINDOWS ) ///////////////////////////////////////// + +namespace Catch { + + struct FatalConditionHandler { + void reset() {} + }; + +} // namespace Catch + +#else // Not Windows - assumed to be POSIX compatible ////////////////////////// + +#include + +namespace Catch { + + struct SignalDefs { int id; const char* name; }; + extern SignalDefs signalDefs[]; + SignalDefs signalDefs[] = { + { SIGINT, "SIGINT - Terminal interrupt signal" }, + { SIGILL, "SIGILL - Illegal instruction signal" }, + { SIGFPE, "SIGFPE - Floating point error signal" }, + { SIGSEGV, "SIGSEGV - Segmentation violation signal" }, + { SIGTERM, "SIGTERM - Termination request signal" }, + { SIGABRT, "SIGABRT - Abort (abnormal termination) signal" } + }; + + struct FatalConditionHandler { + + static void handleSignal( int sig ) { + for( std::size_t i = 0; i < sizeof(signalDefs)/sizeof(SignalDefs); ++i ) + if( sig == signalDefs[i].id ) + fatal( signalDefs[i].name, -sig ); + fatal( "", -sig ); + } + + FatalConditionHandler() : m_isSet( true ) { + for( std::size_t i = 0; i < sizeof(signalDefs)/sizeof(SignalDefs); ++i ) + signal( signalDefs[i].id, handleSignal ); + } + ~FatalConditionHandler() { + reset(); + } + void reset() { + if( m_isSet ) { + for( std::size_t i = 0; i < sizeof(signalDefs)/sizeof(SignalDefs); ++i ) + signal( signalDefs[i].id, SIG_DFL ); + m_isSet = false; + } + } + + bool m_isSet; + }; + +} // namespace Catch + +#endif // not Windows + +#include +#include + +namespace Catch { + + class StreamRedirect { + + public: + StreamRedirect( std::ostream& stream, std::string& targetString ) + : m_stream( stream ), + m_prevBuf( stream.rdbuf() ), + m_targetString( targetString ) + { + stream.rdbuf( m_oss.rdbuf() ); + } + + ~StreamRedirect() { + m_targetString += m_oss.str(); + m_stream.rdbuf( m_prevBuf ); + } + + private: + std::ostream& m_stream; + std::streambuf* m_prevBuf; + std::ostringstream m_oss; + std::string& m_targetString; + }; + + /////////////////////////////////////////////////////////////////////////// + + class RunContext : public IResultCapture, public IRunner { + + RunContext( RunContext const& ); + void operator =( RunContext const& ); + + public: + + explicit RunContext( Ptr const& _config, Ptr const& reporter ) + : m_runInfo( _config->name() ), + m_context( getCurrentMutableContext() ), + m_activeTestCase( CATCH_NULL ), + m_config( _config ), + m_reporter( reporter ) + { + m_context.setRunner( this ); + m_context.setConfig( m_config ); + m_context.setResultCapture( this ); + m_reporter->testRunStarting( m_runInfo ); + } + + virtual ~RunContext() { + m_reporter->testRunEnded( TestRunStats( m_runInfo, m_totals, aborting() ) ); + } + + void testGroupStarting( std::string const& testSpec, std::size_t groupIndex, std::size_t groupsCount ) { + m_reporter->testGroupStarting( GroupInfo( testSpec, groupIndex, groupsCount ) ); + } + void testGroupEnded( std::string const& testSpec, Totals const& totals, std::size_t groupIndex, std::size_t groupsCount ) { + m_reporter->testGroupEnded( TestGroupStats( GroupInfo( testSpec, groupIndex, groupsCount ), totals, aborting() ) ); + } + + Totals runTest( TestCase const& testCase ) { + Totals prevTotals = m_totals; + + std::string redirectedCout; + std::string redirectedCerr; + + TestCaseInfo testInfo = testCase.getTestCaseInfo(); + + m_reporter->testCaseStarting( testInfo ); + + m_activeTestCase = &testCase; + + do { + m_trackerContext.startRun(); + do { + m_trackerContext.startCycle(); + m_testCaseTracker = &SectionTracker::acquire( m_trackerContext, testInfo.name ); + runCurrentTest( redirectedCout, redirectedCerr ); + } + while( !m_testCaseTracker->isSuccessfullyCompleted() && !aborting() ); + } + // !TBD: deprecated - this will be replaced by indexed trackers + while( getCurrentContext().advanceGeneratorsForCurrentTest() && !aborting() ); + + Totals deltaTotals = m_totals.delta( prevTotals ); + if( testInfo.expectedToFail() && deltaTotals.testCases.passed > 0 ) { + deltaTotals.assertions.failed++; + deltaTotals.testCases.passed--; + deltaTotals.testCases.failed++; + } + m_totals.testCases += deltaTotals.testCases; + m_reporter->testCaseEnded( TestCaseStats( testInfo, + deltaTotals, + redirectedCout, + redirectedCerr, + aborting() ) ); + + m_activeTestCase = CATCH_NULL; + m_testCaseTracker = CATCH_NULL; + + return deltaTotals; + } + + Ptr config() const { + return m_config; + } + + private: // IResultCapture + + virtual void assertionEnded( AssertionResult const& result ) { + if( result.getResultType() == ResultWas::Ok ) { + m_totals.assertions.passed++; + } + else if( !result.isOk() ) { + m_totals.assertions.failed++; + } + + if( m_reporter->assertionEnded( AssertionStats( result, m_messages, m_totals ) ) ) + m_messages.clear(); + + // Reset working state + m_lastAssertionInfo = AssertionInfo( "", m_lastAssertionInfo.lineInfo, "{Unknown expression after the reported line}" , m_lastAssertionInfo.resultDisposition ); + m_lastResult = result; + } + + virtual bool sectionStarted ( + SectionInfo const& sectionInfo, + Counts& assertions + ) + { + std::ostringstream oss; + oss << sectionInfo.name << "@" << sectionInfo.lineInfo; + + ITracker& sectionTracker = SectionTracker::acquire( m_trackerContext, oss.str() ); + if( !sectionTracker.isOpen() ) + return false; + m_activeSections.push_back( §ionTracker ); + + m_lastAssertionInfo.lineInfo = sectionInfo.lineInfo; + + m_reporter->sectionStarting( sectionInfo ); + + assertions = m_totals.assertions; + + return true; + } + bool testForMissingAssertions( Counts& assertions ) { + if( assertions.total() != 0 ) + return false; + if( !m_config->warnAboutMissingAssertions() ) + return false; + if( m_trackerContext.currentTracker().hasChildren() ) + return false; + m_totals.assertions.failed++; + assertions.failed++; + return true; + } + + virtual void sectionEnded( SectionEndInfo const& endInfo ) { + Counts assertions = m_totals.assertions - endInfo.prevAssertions; + bool missingAssertions = testForMissingAssertions( assertions ); + + if( !m_activeSections.empty() ) { + m_activeSections.back()->close(); + m_activeSections.pop_back(); + } + + m_reporter->sectionEnded( SectionStats( endInfo.sectionInfo, assertions, endInfo.durationInSeconds, missingAssertions ) ); + m_messages.clear(); + } + + virtual void sectionEndedEarly( SectionEndInfo const& endInfo ) { + if( m_unfinishedSections.empty() ) + m_activeSections.back()->fail(); + else + m_activeSections.back()->close(); + m_activeSections.pop_back(); + + m_unfinishedSections.push_back( endInfo ); + } + + virtual void pushScopedMessage( MessageInfo const& message ) { + m_messages.push_back( message ); + } + + virtual void popScopedMessage( MessageInfo const& message ) { + m_messages.erase( std::remove( m_messages.begin(), m_messages.end(), message ), m_messages.end() ); + } + + virtual std::string getCurrentTestName() const { + return m_activeTestCase + ? m_activeTestCase->getTestCaseInfo().name + : ""; + } + + virtual const AssertionResult* getLastResult() const { + return &m_lastResult; + } + + virtual void handleFatalErrorCondition( std::string const& message ) { + ResultBuilder resultBuilder = makeUnexpectedResultBuilder(); + resultBuilder.setResultType( ResultWas::FatalErrorCondition ); + resultBuilder << message; + resultBuilder.captureExpression(); + + handleUnfinishedSections(); + + // Recreate section for test case (as we will lose the one that was in scope) + TestCaseInfo const& testCaseInfo = m_activeTestCase->getTestCaseInfo(); + SectionInfo testCaseSection( testCaseInfo.lineInfo, testCaseInfo.name, testCaseInfo.description ); + + Counts assertions; + assertions.failed = 1; + SectionStats testCaseSectionStats( testCaseSection, assertions, 0, false ); + m_reporter->sectionEnded( testCaseSectionStats ); + + TestCaseInfo testInfo = m_activeTestCase->getTestCaseInfo(); + + Totals deltaTotals; + deltaTotals.testCases.failed = 1; + m_reporter->testCaseEnded( TestCaseStats( testInfo, + deltaTotals, + "", + "", + false ) ); + m_totals.testCases.failed++; + testGroupEnded( "", m_totals, 1, 1 ); + m_reporter->testRunEnded( TestRunStats( m_runInfo, m_totals, false ) ); + } + + public: + // !TBD We need to do this another way! + bool aborting() const { + return m_totals.assertions.failed == static_cast( m_config->abortAfter() ); + } + + private: + + void runCurrentTest( std::string& redirectedCout, std::string& redirectedCerr ) { + TestCaseInfo const& testCaseInfo = m_activeTestCase->getTestCaseInfo(); + SectionInfo testCaseSection( testCaseInfo.lineInfo, testCaseInfo.name, testCaseInfo.description ); + m_reporter->sectionStarting( testCaseSection ); + Counts prevAssertions = m_totals.assertions; + double duration = 0; + try { + m_lastAssertionInfo = AssertionInfo( "TEST_CASE", testCaseInfo.lineInfo, "", ResultDisposition::Normal ); + + seedRng( *m_config ); + + Timer timer; + timer.start(); + if( m_reporter->getPreferences().shouldRedirectStdOut ) { + StreamRedirect coutRedir( Catch::cout(), redirectedCout ); + StreamRedirect cerrRedir( Catch::cerr(), redirectedCerr ); + invokeActiveTestCase(); + } + else { + invokeActiveTestCase(); + } + duration = timer.getElapsedSeconds(); + } + catch( TestFailureException& ) { + // This just means the test was aborted due to failure + } + catch(...) { + makeUnexpectedResultBuilder().useActiveException(); + } + m_testCaseTracker->close(); + handleUnfinishedSections(); + m_messages.clear(); + + Counts assertions = m_totals.assertions - prevAssertions; + bool missingAssertions = testForMissingAssertions( assertions ); + + if( testCaseInfo.okToFail() ) { + std::swap( assertions.failedButOk, assertions.failed ); + m_totals.assertions.failed -= assertions.failedButOk; + m_totals.assertions.failedButOk += assertions.failedButOk; + } + + SectionStats testCaseSectionStats( testCaseSection, assertions, duration, missingAssertions ); + m_reporter->sectionEnded( testCaseSectionStats ); + } + + void invokeActiveTestCase() { + FatalConditionHandler fatalConditionHandler; // Handle signals + m_activeTestCase->invoke(); + fatalConditionHandler.reset(); + } + + private: + + ResultBuilder makeUnexpectedResultBuilder() const { + return ResultBuilder( m_lastAssertionInfo.macroName.c_str(), + m_lastAssertionInfo.lineInfo, + m_lastAssertionInfo.capturedExpression.c_str(), + m_lastAssertionInfo.resultDisposition ); + } + + void handleUnfinishedSections() { + // If sections ended prematurely due to an exception we stored their + // infos here so we can tear them down outside the unwind process. + for( std::vector::const_reverse_iterator it = m_unfinishedSections.rbegin(), + itEnd = m_unfinishedSections.rend(); + it != itEnd; + ++it ) + sectionEnded( *it ); + m_unfinishedSections.clear(); + } + + TestRunInfo m_runInfo; + IMutableContext& m_context; + TestCase const* m_activeTestCase; + ITracker* m_testCaseTracker; + ITracker* m_currentSectionTracker; + AssertionResult m_lastResult; + + Ptr m_config; + Totals m_totals; + Ptr m_reporter; + std::vector m_messages; + AssertionInfo m_lastAssertionInfo; + std::vector m_unfinishedSections; + std::vector m_activeSections; + TrackerContext m_trackerContext; + }; + + IResultCapture& getResultCapture() { + if( IResultCapture* capture = getCurrentContext().getResultCapture() ) + return *capture; + else + throw std::logic_error( "No result capture instance" ); + } + +} // end namespace Catch + +// #included from: internal/catch_version.h +#define TWOBLUECUBES_CATCH_VERSION_H_INCLUDED + +namespace Catch { + + // Versioning information + struct Version { + Version( unsigned int _majorVersion, + unsigned int _minorVersion, + unsigned int _patchNumber, + std::string const& _branchName, + unsigned int _buildNumber ); + + unsigned int const majorVersion; + unsigned int const minorVersion; + unsigned int const patchNumber; + + // buildNumber is only used if branchName is not null + std::string const branchName; + unsigned int const buildNumber; + + friend std::ostream& operator << ( std::ostream& os, Version const& version ); + + private: + void operator=( Version const& ); + }; + + extern Version libraryVersion; +} + +#include +#include +#include + +namespace Catch { + + Ptr createReporter( std::string const& reporterName, Ptr const& config ) { + Ptr reporter = getRegistryHub().getReporterRegistry().create( reporterName, config.get() ); + if( !reporter ) { + std::ostringstream oss; + oss << "No reporter registered with name: '" << reporterName << "'"; + throw std::domain_error( oss.str() ); + } + return reporter; + } + + Ptr makeReporter( Ptr const& config ) { + std::vector reporters = config->getReporterNames(); + if( reporters.empty() ) + reporters.push_back( "console" ); + + Ptr reporter; + for( std::vector::const_iterator it = reporters.begin(), itEnd = reporters.end(); + it != itEnd; + ++it ) + reporter = addReporter( reporter, createReporter( *it, config ) ); + return reporter; + } + Ptr addListeners( Ptr const& config, Ptr reporters ) { + IReporterRegistry::Listeners listeners = getRegistryHub().getReporterRegistry().getListeners(); + for( IReporterRegistry::Listeners::const_iterator it = listeners.begin(), itEnd = listeners.end(); + it != itEnd; + ++it ) + reporters = addReporter(reporters, (*it)->create( ReporterConfig( config ) ) ); + return reporters; + } + + Totals runTests( Ptr const& config ) { + + Ptr iconfig = config.get(); + + Ptr reporter = makeReporter( config ); + reporter = addListeners( iconfig, reporter ); + + RunContext context( iconfig, reporter ); + + Totals totals; + + context.testGroupStarting( config->name(), 1, 1 ); + + TestSpec testSpec = config->testSpec(); + if( !testSpec.hasFilters() ) + testSpec = TestSpecParser( ITagAliasRegistry::get() ).parse( "~[.]" ).testSpec(); // All not hidden tests + + std::vector const& allTestCases = getAllTestCasesSorted( *iconfig ); + for( std::vector::const_iterator it = allTestCases.begin(), itEnd = allTestCases.end(); + it != itEnd; + ++it ) { + if( !context.aborting() && matchTest( *it, testSpec, *iconfig ) ) + totals += context.runTest( *it ); + else + reporter->skipTest( *it ); + } + + context.testGroupEnded( iconfig->name(), totals, 1, 1 ); + return totals; + } + + void applyFilenamesAsTags( IConfig const& config ) { + std::vector const& tests = getAllTestCasesSorted( config ); + for(std::size_t i = 0; i < tests.size(); ++i ) { + TestCase& test = const_cast( tests[i] ); + std::set tags = test.tags; + + std::string filename = test.lineInfo.file; + std::string::size_type lastSlash = filename.find_last_of( "\\/" ); + if( lastSlash != std::string::npos ) + filename = filename.substr( lastSlash+1 ); + + std::string::size_type lastDot = filename.find_last_of( "." ); + if( lastDot != std::string::npos ) + filename = filename.substr( 0, lastDot ); + + tags.insert( "#" + filename ); + setTags( test, tags ); + } + } + + class Session : NonCopyable { + static bool alreadyInstantiated; + + public: + + struct OnUnusedOptions { enum DoWhat { Ignore, Fail }; }; + + Session() + : m_cli( makeCommandLineParser() ) { + if( alreadyInstantiated ) { + std::string msg = "Only one instance of Catch::Session can ever be used"; + Catch::cerr() << msg << std::endl; + throw std::logic_error( msg ); + } + alreadyInstantiated = true; + } + ~Session() { + Catch::cleanUp(); + } + + void showHelp( std::string const& processName ) { + Catch::cout() << "\nCatch v" << libraryVersion << "\n"; + + m_cli.usage( Catch::cout(), processName ); + Catch::cout() << "For more detail usage please see the project docs\n" << std::endl; + } + + int applyCommandLine( int argc, char const* argv[], OnUnusedOptions::DoWhat unusedOptionBehaviour = OnUnusedOptions::Fail ) { + try { + m_cli.setThrowOnUnrecognisedTokens( unusedOptionBehaviour == OnUnusedOptions::Fail ); + m_unusedTokens = m_cli.parseInto( argc, argv, m_configData ); + if( m_configData.showHelp ) + showHelp( m_configData.processName ); + m_config.reset(); + } + catch( std::exception& ex ) { + { + Colour colourGuard( Colour::Red ); + Catch::cerr() + << "\nError(s) in input:\n" + << Text( ex.what(), TextAttributes().setIndent(2) ) + << "\n\n"; + } + m_cli.usage( Catch::cout(), m_configData.processName ); + return (std::numeric_limits::max)(); + } + return 0; + } + + void useConfigData( ConfigData const& _configData ) { + m_configData = _configData; + m_config.reset(); + } + + int run( int argc, char const* argv[] ) { + + int returnCode = applyCommandLine( argc, argv ); + if( returnCode == 0 ) + returnCode = run(); + return returnCode; + } + int run( int argc, char* argv[] ) { + return run( argc, const_cast( argv ) ); + } + + int run() { + if( m_configData.showHelp ) + return 0; + + try + { + config(); // Force config to be constructed + + seedRng( *m_config ); + + if( m_configData.filenamesAsTags ) + applyFilenamesAsTags( *m_config ); + + // Handle list request + if( Option listed = list( config() ) ) + return static_cast( *listed ); + + return static_cast( runTests( m_config ).assertions.failed ); + } + catch( std::exception& ex ) { + Catch::cerr() << ex.what() << std::endl; + return (std::numeric_limits::max)(); + } + } + + Clara::CommandLine const& cli() const { + return m_cli; + } + std::vector const& unusedTokens() const { + return m_unusedTokens; + } + ConfigData& configData() { + return m_configData; + } + Config& config() { + if( !m_config ) + m_config = new Config( m_configData ); + return *m_config; + } + private: + Clara::CommandLine m_cli; + std::vector m_unusedTokens; + ConfigData m_configData; + Ptr m_config; + }; + + bool Session::alreadyInstantiated = false; + +} // end namespace Catch + +// #included from: catch_registry_hub.hpp +#define TWOBLUECUBES_CATCH_REGISTRY_HUB_HPP_INCLUDED + +// #included from: catch_test_case_registry_impl.hpp +#define TWOBLUECUBES_CATCH_TEST_CASE_REGISTRY_IMPL_HPP_INCLUDED + +#include +#include +#include +#include +#include + +namespace Catch { + + struct LexSort { + bool operator() (TestCase i,TestCase j) const { return (i sortTests( IConfig const& config, std::vector const& unsortedTestCases ) { + + std::vector sorted = unsortedTestCases; + + switch( config.runOrder() ) { + case RunTests::InLexicographicalOrder: + std::sort( sorted.begin(), sorted.end(), LexSort() ); + break; + case RunTests::InRandomOrder: + { + seedRng( config ); + + RandomNumberGenerator rng; + std::random_shuffle( sorted.begin(), sorted.end(), rng ); + } + break; + case RunTests::InDeclarationOrder: + // already in declaration order + break; + } + return sorted; + } + bool matchTest( TestCase const& testCase, TestSpec const& testSpec, IConfig const& config ) { + return testSpec.matches( testCase ) && ( config.allowThrows() || !testCase.throws() ); + } + + void enforceNoDuplicateTestCases( std::vector const& functions ) { + std::set seenFunctions; + for( std::vector::const_iterator it = functions.begin(), itEnd = functions.end(); + it != itEnd; + ++it ) { + std::pair::const_iterator, bool> prev = seenFunctions.insert( *it ); + if( !prev.second ){ + Catch::cerr() + << Colour( Colour::Red ) + << "error: TEST_CASE( \"" << it->name << "\" ) already defined.\n" + << "\tFirst seen at " << prev.first->getTestCaseInfo().lineInfo << "\n" + << "\tRedefined at " << it->getTestCaseInfo().lineInfo << std::endl; + exit(1); + } + } + } + + std::vector filterTests( std::vector const& testCases, TestSpec const& testSpec, IConfig const& config ) { + std::vector filtered; + filtered.reserve( testCases.size() ); + for( std::vector::const_iterator it = testCases.begin(), itEnd = testCases.end(); + it != itEnd; + ++it ) + if( matchTest( *it, testSpec, config ) ) + filtered.push_back( *it ); + return filtered; + } + std::vector const& getAllTestCasesSorted( IConfig const& config ) { + return getRegistryHub().getTestCaseRegistry().getAllTestsSorted( config ); + } + + class TestRegistry : public ITestCaseRegistry { + public: + TestRegistry() + : m_currentSortOrder( RunTests::InDeclarationOrder ), + m_unnamedCount( 0 ) + {} + virtual ~TestRegistry(); + + virtual void registerTest( TestCase const& testCase ) { + std::string name = testCase.getTestCaseInfo().name; + if( name == "" ) { + std::ostringstream oss; + oss << "Anonymous test case " << ++m_unnamedCount; + return registerTest( testCase.withName( oss.str() ) ); + } + m_functions.push_back( testCase ); + } + + virtual std::vector const& getAllTests() const { + return m_functions; + } + virtual std::vector const& getAllTestsSorted( IConfig const& config ) const { + if( m_sortedFunctions.empty() ) + enforceNoDuplicateTestCases( m_functions ); + + if( m_currentSortOrder != config.runOrder() || m_sortedFunctions.empty() ) { + m_sortedFunctions = sortTests( config, m_functions ); + m_currentSortOrder = config.runOrder(); + } + return m_sortedFunctions; + } + + private: + std::vector m_functions; + mutable RunTests::InWhatOrder m_currentSortOrder; + mutable std::vector m_sortedFunctions; + size_t m_unnamedCount; + std::ios_base::Init m_ostreamInit; // Forces cout/ cerr to be initialised + }; + + /////////////////////////////////////////////////////////////////////////// + + class FreeFunctionTestCase : public SharedImpl { + public: + + FreeFunctionTestCase( TestFunction fun ) : m_fun( fun ) {} + + virtual void invoke() const { + m_fun(); + } + + private: + virtual ~FreeFunctionTestCase(); + + TestFunction m_fun; + }; + + inline std::string extractClassName( std::string const& classOrQualifiedMethodName ) { + std::string className = classOrQualifiedMethodName; + if( startsWith( className, "&" ) ) + { + std::size_t lastColons = className.rfind( "::" ); + std::size_t penultimateColons = className.rfind( "::", lastColons-1 ); + if( penultimateColons == std::string::npos ) + penultimateColons = 1; + className = className.substr( penultimateColons, lastColons-penultimateColons ); + } + return className; + } + + void registerTestCase + ( ITestCase* testCase, + char const* classOrQualifiedMethodName, + NameAndDesc const& nameAndDesc, + SourceLineInfo const& lineInfo ) { + + getMutableRegistryHub().registerTest + ( makeTestCase + ( testCase, + extractClassName( classOrQualifiedMethodName ), + nameAndDesc.name, + nameAndDesc.description, + lineInfo ) ); + } + void registerTestCaseFunction + ( TestFunction function, + SourceLineInfo const& lineInfo, + NameAndDesc const& nameAndDesc ) { + registerTestCase( new FreeFunctionTestCase( function ), "", nameAndDesc, lineInfo ); + } + + /////////////////////////////////////////////////////////////////////////// + + AutoReg::AutoReg + ( TestFunction function, + SourceLineInfo const& lineInfo, + NameAndDesc const& nameAndDesc ) { + registerTestCaseFunction( function, lineInfo, nameAndDesc ); + } + + AutoReg::~AutoReg() {} + +} // end namespace Catch + +// #included from: catch_reporter_registry.hpp +#define TWOBLUECUBES_CATCH_REPORTER_REGISTRY_HPP_INCLUDED + +#include + +namespace Catch { + + class ReporterRegistry : public IReporterRegistry { + + public: + + virtual ~ReporterRegistry() CATCH_OVERRIDE {} + + virtual IStreamingReporter* create( std::string const& name, Ptr const& config ) const CATCH_OVERRIDE { + FactoryMap::const_iterator it = m_factories.find( name ); + if( it == m_factories.end() ) + return CATCH_NULL; + return it->second->create( ReporterConfig( config ) ); + } + + void registerReporter( std::string const& name, Ptr const& factory ) { + m_factories.insert( std::make_pair( name, factory ) ); + } + void registerListener( Ptr const& factory ) { + m_listeners.push_back( factory ); + } + + virtual FactoryMap const& getFactories() const CATCH_OVERRIDE { + return m_factories; + } + virtual Listeners const& getListeners() const CATCH_OVERRIDE { + return m_listeners; + } + + private: + FactoryMap m_factories; + Listeners m_listeners; + }; +} + +// #included from: catch_exception_translator_registry.hpp +#define TWOBLUECUBES_CATCH_EXCEPTION_TRANSLATOR_REGISTRY_HPP_INCLUDED + +#ifdef __OBJC__ +#import "Foundation/Foundation.h" +#endif + +namespace Catch { + + class ExceptionTranslatorRegistry : public IExceptionTranslatorRegistry { + public: + ~ExceptionTranslatorRegistry() { + deleteAll( m_translators ); + } + + virtual void registerTranslator( const IExceptionTranslator* translator ) { + m_translators.push_back( translator ); + } + + virtual std::string translateActiveException() const { + try { +#ifdef __OBJC__ + // In Objective-C try objective-c exceptions first + @try { + return tryTranslators(); + } + @catch (NSException *exception) { + return Catch::toString( [exception description] ); + } +#else + return tryTranslators(); +#endif + } + catch( TestFailureException& ) { + throw; + } + catch( std::exception& ex ) { + return ex.what(); + } + catch( std::string& msg ) { + return msg; + } + catch( const char* msg ) { + return msg; + } + catch(...) { + return "Unknown exception"; + } + } + + std::string tryTranslators() const { + if( m_translators.empty() ) + throw; + else + return m_translators[0]->translate( m_translators.begin()+1, m_translators.end() ); + } + + private: + std::vector m_translators; + }; +} + +namespace Catch { + + namespace { + + class RegistryHub : public IRegistryHub, public IMutableRegistryHub { + + RegistryHub( RegistryHub const& ); + void operator=( RegistryHub const& ); + + public: // IRegistryHub + RegistryHub() { + } + virtual IReporterRegistry const& getReporterRegistry() const CATCH_OVERRIDE { + return m_reporterRegistry; + } + virtual ITestCaseRegistry const& getTestCaseRegistry() const CATCH_OVERRIDE { + return m_testCaseRegistry; + } + virtual IExceptionTranslatorRegistry& getExceptionTranslatorRegistry() CATCH_OVERRIDE { + return m_exceptionTranslatorRegistry; + } + + public: // IMutableRegistryHub + virtual void registerReporter( std::string const& name, Ptr const& factory ) CATCH_OVERRIDE { + m_reporterRegistry.registerReporter( name, factory ); + } + virtual void registerListener( Ptr const& factory ) CATCH_OVERRIDE { + m_reporterRegistry.registerListener( factory ); + } + virtual void registerTest( TestCase const& testInfo ) CATCH_OVERRIDE { + m_testCaseRegistry.registerTest( testInfo ); + } + virtual void registerTranslator( const IExceptionTranslator* translator ) CATCH_OVERRIDE { + m_exceptionTranslatorRegistry.registerTranslator( translator ); + } + + private: + TestRegistry m_testCaseRegistry; + ReporterRegistry m_reporterRegistry; + ExceptionTranslatorRegistry m_exceptionTranslatorRegistry; + }; + + // Single, global, instance + inline RegistryHub*& getTheRegistryHub() { + static RegistryHub* theRegistryHub = CATCH_NULL; + if( !theRegistryHub ) + theRegistryHub = new RegistryHub(); + return theRegistryHub; + } + } + + IRegistryHub& getRegistryHub() { + return *getTheRegistryHub(); + } + IMutableRegistryHub& getMutableRegistryHub() { + return *getTheRegistryHub(); + } + void cleanUp() { + delete getTheRegistryHub(); + getTheRegistryHub() = CATCH_NULL; + cleanUpContext(); + } + std::string translateActiveException() { + return getRegistryHub().getExceptionTranslatorRegistry().translateActiveException(); + } + +} // end namespace Catch + +// #included from: catch_notimplemented_exception.hpp +#define TWOBLUECUBES_CATCH_NOTIMPLEMENTED_EXCEPTION_HPP_INCLUDED + +#include + +namespace Catch { + + NotImplementedException::NotImplementedException( SourceLineInfo const& lineInfo ) + : m_lineInfo( lineInfo ) { + std::ostringstream oss; + oss << lineInfo << ": function "; + oss << "not implemented"; + m_what = oss.str(); + } + + const char* NotImplementedException::what() const CATCH_NOEXCEPT { + return m_what.c_str(); + } + +} // end namespace Catch + +// #included from: catch_context_impl.hpp +#define TWOBLUECUBES_CATCH_CONTEXT_IMPL_HPP_INCLUDED + +// #included from: catch_stream.hpp +#define TWOBLUECUBES_CATCH_STREAM_HPP_INCLUDED + +#include +#include +#include + +namespace Catch { + + template + class StreamBufImpl : public StreamBufBase { + char data[bufferSize]; + WriterF m_writer; + + public: + StreamBufImpl() { + setp( data, data + sizeof(data) ); + } + + ~StreamBufImpl() CATCH_NOEXCEPT { + sync(); + } + + private: + int overflow( int c ) { + sync(); + + if( c != EOF ) { + if( pbase() == epptr() ) + m_writer( std::string( 1, static_cast( c ) ) ); + else + sputc( static_cast( c ) ); + } + return 0; + } + + int sync() { + if( pbase() != pptr() ) { + m_writer( std::string( pbase(), static_cast( pptr() - pbase() ) ) ); + setp( pbase(), epptr() ); + } + return 0; + } + }; + + /////////////////////////////////////////////////////////////////////////// + + FileStream::FileStream( std::string const& filename ) { + m_ofs.open( filename.c_str() ); + if( m_ofs.fail() ) { + std::ostringstream oss; + oss << "Unable to open file: '" << filename << "'"; + throw std::domain_error( oss.str() ); + } + } + + std::ostream& FileStream::stream() const { + return m_ofs; + } + + struct OutputDebugWriter { + + void operator()( std::string const&str ) { + writeToDebugConsole( str ); + } + }; + + DebugOutStream::DebugOutStream() + : m_streamBuf( new StreamBufImpl() ), + m_os( m_streamBuf.get() ) + {} + + std::ostream& DebugOutStream::stream() const { + return m_os; + } + + // Store the streambuf from cout up-front because + // cout may get redirected when running tests + CoutStream::CoutStream() + : m_os( Catch::cout().rdbuf() ) + {} + + std::ostream& CoutStream::stream() const { + return m_os; + } + +#ifndef CATCH_CONFIG_NOSTDOUT // If you #define this you must implement these functions + std::ostream& cout() { + return std::cout; + } + std::ostream& cerr() { + return std::cerr; + } +#endif +} + +namespace Catch { + + class Context : public IMutableContext { + + Context() : m_config( CATCH_NULL ), m_runner( CATCH_NULL ), m_resultCapture( CATCH_NULL ) {} + Context( Context const& ); + void operator=( Context const& ); + + public: // IContext + virtual IResultCapture* getResultCapture() { + return m_resultCapture; + } + virtual IRunner* getRunner() { + return m_runner; + } + virtual size_t getGeneratorIndex( std::string const& fileInfo, size_t totalSize ) { + return getGeneratorsForCurrentTest() + .getGeneratorInfo( fileInfo, totalSize ) + .getCurrentIndex(); + } + virtual bool advanceGeneratorsForCurrentTest() { + IGeneratorsForTest* generators = findGeneratorsForCurrentTest(); + return generators && generators->moveNext(); + } + + virtual Ptr getConfig() const { + return m_config; + } + + public: // IMutableContext + virtual void setResultCapture( IResultCapture* resultCapture ) { + m_resultCapture = resultCapture; + } + virtual void setRunner( IRunner* runner ) { + m_runner = runner; + } + virtual void setConfig( Ptr const& config ) { + m_config = config; + } + + friend IMutableContext& getCurrentMutableContext(); + + private: + IGeneratorsForTest* findGeneratorsForCurrentTest() { + std::string testName = getResultCapture()->getCurrentTestName(); + + std::map::const_iterator it = + m_generatorsByTestName.find( testName ); + return it != m_generatorsByTestName.end() + ? it->second + : CATCH_NULL; + } + + IGeneratorsForTest& getGeneratorsForCurrentTest() { + IGeneratorsForTest* generators = findGeneratorsForCurrentTest(); + if( !generators ) { + std::string testName = getResultCapture()->getCurrentTestName(); + generators = createGeneratorsForTest(); + m_generatorsByTestName.insert( std::make_pair( testName, generators ) ); + } + return *generators; + } + + private: + Ptr m_config; + IRunner* m_runner; + IResultCapture* m_resultCapture; + std::map m_generatorsByTestName; + }; + + namespace { + Context* currentContext = CATCH_NULL; + } + IMutableContext& getCurrentMutableContext() { + if( !currentContext ) + currentContext = new Context(); + return *currentContext; + } + IContext& getCurrentContext() { + return getCurrentMutableContext(); + } + + void cleanUpContext() { + delete currentContext; + currentContext = CATCH_NULL; + } +} + +// #included from: catch_console_colour_impl.hpp +#define TWOBLUECUBES_CATCH_CONSOLE_COLOUR_IMPL_HPP_INCLUDED + +namespace Catch { + namespace { + + struct IColourImpl { + virtual ~IColourImpl() {} + virtual void use( Colour::Code _colourCode ) = 0; + }; + + struct NoColourImpl : IColourImpl { + void use( Colour::Code ) {} + + static IColourImpl* instance() { + static NoColourImpl s_instance; + return &s_instance; + } + }; + + } // anon namespace +} // namespace Catch + +#if !defined( CATCH_CONFIG_COLOUR_NONE ) && !defined( CATCH_CONFIG_COLOUR_WINDOWS ) && !defined( CATCH_CONFIG_COLOUR_ANSI ) +# ifdef CATCH_PLATFORM_WINDOWS +# define CATCH_CONFIG_COLOUR_WINDOWS +# else +# define CATCH_CONFIG_COLOUR_ANSI +# endif +#endif + +#if defined ( CATCH_CONFIG_COLOUR_WINDOWS ) ///////////////////////////////////////// + +#ifndef NOMINMAX +#define NOMINMAX +#endif + +#ifdef __AFXDLL +#include +#else +#include +#endif + +namespace Catch { +namespace { + + class Win32ColourImpl : public IColourImpl { + public: + Win32ColourImpl() : stdoutHandle( GetStdHandle(STD_OUTPUT_HANDLE) ) + { + CONSOLE_SCREEN_BUFFER_INFO csbiInfo; + GetConsoleScreenBufferInfo( stdoutHandle, &csbiInfo ); + originalForegroundAttributes = csbiInfo.wAttributes & ~( BACKGROUND_GREEN | BACKGROUND_RED | BACKGROUND_BLUE | BACKGROUND_INTENSITY ); + originalBackgroundAttributes = csbiInfo.wAttributes & ~( FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_INTENSITY ); + } + + virtual void use( Colour::Code _colourCode ) { + switch( _colourCode ) { + case Colour::None: return setTextAttribute( originalForegroundAttributes ); + case Colour::White: return setTextAttribute( FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_BLUE ); + case Colour::Red: return setTextAttribute( FOREGROUND_RED ); + case Colour::Green: return setTextAttribute( FOREGROUND_GREEN ); + case Colour::Blue: return setTextAttribute( FOREGROUND_BLUE ); + case Colour::Cyan: return setTextAttribute( FOREGROUND_BLUE | FOREGROUND_GREEN ); + case Colour::Yellow: return setTextAttribute( FOREGROUND_RED | FOREGROUND_GREEN ); + case Colour::Grey: return setTextAttribute( 0 ); + + case Colour::LightGrey: return setTextAttribute( FOREGROUND_INTENSITY ); + case Colour::BrightRed: return setTextAttribute( FOREGROUND_INTENSITY | FOREGROUND_RED ); + case Colour::BrightGreen: return setTextAttribute( FOREGROUND_INTENSITY | FOREGROUND_GREEN ); + case Colour::BrightWhite: return setTextAttribute( FOREGROUND_INTENSITY | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_BLUE ); + + case Colour::Bright: throw std::logic_error( "not a colour" ); + } + } + + private: + void setTextAttribute( WORD _textAttribute ) { + SetConsoleTextAttribute( stdoutHandle, _textAttribute | originalBackgroundAttributes ); + } + HANDLE stdoutHandle; + WORD originalForegroundAttributes; + WORD originalBackgroundAttributes; + }; + + IColourImpl* platformColourInstance() { + static Win32ColourImpl s_instance; + + Ptr config = getCurrentContext().getConfig(); + UseColour::YesOrNo colourMode = config + ? config->useColour() + : UseColour::Auto; + if( colourMode == UseColour::Auto ) + colourMode = !isDebuggerActive() + ? UseColour::Yes + : UseColour::No; + return colourMode == UseColour::Yes + ? &s_instance + : NoColourImpl::instance(); + } + +} // end anon namespace +} // end namespace Catch + +#elif defined( CATCH_CONFIG_COLOUR_ANSI ) ////////////////////////////////////// + +#include + +namespace Catch { +namespace { + + // use POSIX/ ANSI console terminal codes + // Thanks to Adam Strzelecki for original contribution + // (http://github.com/nanoant) + // https://github.com/philsquared/Catch/pull/131 + class PosixColourImpl : public IColourImpl { + public: + virtual void use( Colour::Code _colourCode ) { + switch( _colourCode ) { + case Colour::None: + case Colour::White: return setColour( "[0m" ); + case Colour::Red: return setColour( "[0;31m" ); + case Colour::Green: return setColour( "[0;32m" ); + case Colour::Blue: return setColour( "[0:34m" ); + case Colour::Cyan: return setColour( "[0;36m" ); + case Colour::Yellow: return setColour( "[0;33m" ); + case Colour::Grey: return setColour( "[1;30m" ); + + case Colour::LightGrey: return setColour( "[0;37m" ); + case Colour::BrightRed: return setColour( "[1;31m" ); + case Colour::BrightGreen: return setColour( "[1;32m" ); + case Colour::BrightWhite: return setColour( "[1;37m" ); + + case Colour::Bright: throw std::logic_error( "not a colour" ); + } + } + static IColourImpl* instance() { + static PosixColourImpl s_instance; + return &s_instance; + } + + private: + void setColour( const char* _escapeCode ) { + Catch::cout() << '\033' << _escapeCode; + } + }; + + IColourImpl* platformColourInstance() { + Ptr config = getCurrentContext().getConfig(); + UseColour::YesOrNo colourMode = config + ? config->useColour() + : UseColour::Auto; + if( colourMode == UseColour::Auto ) + colourMode = (!isDebuggerActive() && isatty(STDOUT_FILENO) ) + ? UseColour::Yes + : UseColour::No; + return colourMode == UseColour::Yes + ? PosixColourImpl::instance() + : NoColourImpl::instance(); + } + +} // end anon namespace +} // end namespace Catch + +#else // not Windows or ANSI /////////////////////////////////////////////// + +namespace Catch { + + static IColourImpl* platformColourInstance() { return NoColourImpl::instance(); } + +} // end namespace Catch + +#endif // Windows/ ANSI/ None + +namespace Catch { + + Colour::Colour( Code _colourCode ) : m_moved( false ) { use( _colourCode ); } + Colour::Colour( Colour const& _other ) : m_moved( false ) { const_cast( _other ).m_moved = true; } + Colour::~Colour(){ if( !m_moved ) use( None ); } + + void Colour::use( Code _colourCode ) { + static IColourImpl* impl = platformColourInstance(); + impl->use( _colourCode ); + } + +} // end namespace Catch + +// #included from: catch_generators_impl.hpp +#define TWOBLUECUBES_CATCH_GENERATORS_IMPL_HPP_INCLUDED + +#include +#include +#include + +namespace Catch { + + struct GeneratorInfo : IGeneratorInfo { + + GeneratorInfo( std::size_t size ) + : m_size( size ), + m_currentIndex( 0 ) + {} + + bool moveNext() { + if( ++m_currentIndex == m_size ) { + m_currentIndex = 0; + return false; + } + return true; + } + + std::size_t getCurrentIndex() const { + return m_currentIndex; + } + + std::size_t m_size; + std::size_t m_currentIndex; + }; + + /////////////////////////////////////////////////////////////////////////// + + class GeneratorsForTest : public IGeneratorsForTest { + + public: + ~GeneratorsForTest() { + deleteAll( m_generatorsInOrder ); + } + + IGeneratorInfo& getGeneratorInfo( std::string const& fileInfo, std::size_t size ) { + std::map::const_iterator it = m_generatorsByName.find( fileInfo ); + if( it == m_generatorsByName.end() ) { + IGeneratorInfo* info = new GeneratorInfo( size ); + m_generatorsByName.insert( std::make_pair( fileInfo, info ) ); + m_generatorsInOrder.push_back( info ); + return *info; + } + return *it->second; + } + + bool moveNext() { + std::vector::const_iterator it = m_generatorsInOrder.begin(); + std::vector::const_iterator itEnd = m_generatorsInOrder.end(); + for(; it != itEnd; ++it ) { + if( (*it)->moveNext() ) + return true; + } + return false; + } + + private: + std::map m_generatorsByName; + std::vector m_generatorsInOrder; + }; + + IGeneratorsForTest* createGeneratorsForTest() + { + return new GeneratorsForTest(); + } + +} // end namespace Catch + +// #included from: catch_assertionresult.hpp +#define TWOBLUECUBES_CATCH_ASSERTIONRESULT_HPP_INCLUDED + +namespace Catch { + + AssertionInfo::AssertionInfo( std::string const& _macroName, + SourceLineInfo const& _lineInfo, + std::string const& _capturedExpression, + ResultDisposition::Flags _resultDisposition ) + : macroName( _macroName ), + lineInfo( _lineInfo ), + capturedExpression( _capturedExpression ), + resultDisposition( _resultDisposition ) + {} + + AssertionResult::AssertionResult() {} + + AssertionResult::AssertionResult( AssertionInfo const& info, AssertionResultData const& data ) + : m_info( info ), + m_resultData( data ) + {} + + AssertionResult::~AssertionResult() {} + + // Result was a success + bool AssertionResult::succeeded() const { + return Catch::isOk( m_resultData.resultType ); + } + + // Result was a success, or failure is suppressed + bool AssertionResult::isOk() const { + return Catch::isOk( m_resultData.resultType ) || shouldSuppressFailure( m_info.resultDisposition ); + } + + ResultWas::OfType AssertionResult::getResultType() const { + return m_resultData.resultType; + } + + bool AssertionResult::hasExpression() const { + return !m_info.capturedExpression.empty(); + } + + bool AssertionResult::hasMessage() const { + return !m_resultData.message.empty(); + } + + std::string AssertionResult::getExpression() const { + if( isFalseTest( m_info.resultDisposition ) ) + return "!" + m_info.capturedExpression; + else + return m_info.capturedExpression; + } + std::string AssertionResult::getExpressionInMacro() const { + if( m_info.macroName.empty() ) + return m_info.capturedExpression; + else + return m_info.macroName + "( " + m_info.capturedExpression + " )"; + } + + bool AssertionResult::hasExpandedExpression() const { + return hasExpression() && getExpandedExpression() != getExpression(); + } + + std::string AssertionResult::getExpandedExpression() const { + return m_resultData.reconstructedExpression; + } + + std::string AssertionResult::getMessage() const { + return m_resultData.message; + } + SourceLineInfo AssertionResult::getSourceInfo() const { + return m_info.lineInfo; + } + + std::string AssertionResult::getTestMacroName() const { + return m_info.macroName; + } + +} // end namespace Catch + +// #included from: catch_test_case_info.hpp +#define TWOBLUECUBES_CATCH_TEST_CASE_INFO_HPP_INCLUDED + +namespace Catch { + + inline TestCaseInfo::SpecialProperties parseSpecialTag( std::string const& tag ) { + if( startsWith( tag, "." ) || + tag == "hide" || + tag == "!hide" ) + return TestCaseInfo::IsHidden; + else if( tag == "!throws" ) + return TestCaseInfo::Throws; + else if( tag == "!shouldfail" ) + return TestCaseInfo::ShouldFail; + else if( tag == "!mayfail" ) + return TestCaseInfo::MayFail; + else + return TestCaseInfo::None; + } + inline bool isReservedTag( std::string const& tag ) { + return parseSpecialTag( tag ) == TestCaseInfo::None && tag.size() > 0 && !isalnum( tag[0] ); + } + inline void enforceNotReservedTag( std::string const& tag, SourceLineInfo const& _lineInfo ) { + if( isReservedTag( tag ) ) { + { + Colour colourGuard( Colour::Red ); + Catch::cerr() + << "Tag name [" << tag << "] not allowed.\n" + << "Tag names starting with non alpha-numeric characters are reserved\n"; + } + { + Colour colourGuard( Colour::FileName ); + Catch::cerr() << _lineInfo << std::endl; + } + exit(1); + } + } + + TestCase makeTestCase( ITestCase* _testCase, + std::string const& _className, + std::string const& _name, + std::string const& _descOrTags, + SourceLineInfo const& _lineInfo ) + { + bool isHidden( startsWith( _name, "./" ) ); // Legacy support + + // Parse out tags + std::set tags; + std::string desc, tag; + bool inTag = false; + for( std::size_t i = 0; i < _descOrTags.size(); ++i ) { + char c = _descOrTags[i]; + if( !inTag ) { + if( c == '[' ) + inTag = true; + else + desc += c; + } + else { + if( c == ']' ) { + TestCaseInfo::SpecialProperties prop = parseSpecialTag( tag ); + if( prop == TestCaseInfo::IsHidden ) + isHidden = true; + else if( prop == TestCaseInfo::None ) + enforceNotReservedTag( tag, _lineInfo ); + + tags.insert( tag ); + tag.clear(); + inTag = false; + } + else + tag += c; + } + } + if( isHidden ) { + tags.insert( "hide" ); + tags.insert( "." ); + } + + TestCaseInfo info( _name, _className, desc, tags, _lineInfo ); + return TestCase( _testCase, info ); + } + + void setTags( TestCaseInfo& testCaseInfo, std::set const& tags ) + { + testCaseInfo.tags = tags; + testCaseInfo.lcaseTags.clear(); + + std::ostringstream oss; + for( std::set::const_iterator it = tags.begin(), itEnd = tags.end(); it != itEnd; ++it ) { + oss << "[" << *it << "]"; + std::string lcaseTag = toLower( *it ); + testCaseInfo.properties = static_cast( testCaseInfo.properties | parseSpecialTag( lcaseTag ) ); + testCaseInfo.lcaseTags.insert( lcaseTag ); + } + testCaseInfo.tagsAsString = oss.str(); + } + + TestCaseInfo::TestCaseInfo( std::string const& _name, + std::string const& _className, + std::string const& _description, + std::set const& _tags, + SourceLineInfo const& _lineInfo ) + : name( _name ), + className( _className ), + description( _description ), + lineInfo( _lineInfo ), + properties( None ) + { + setTags( *this, _tags ); + } + + TestCaseInfo::TestCaseInfo( TestCaseInfo const& other ) + : name( other.name ), + className( other.className ), + description( other.description ), + tags( other.tags ), + lcaseTags( other.lcaseTags ), + tagsAsString( other.tagsAsString ), + lineInfo( other.lineInfo ), + properties( other.properties ) + {} + + bool TestCaseInfo::isHidden() const { + return ( properties & IsHidden ) != 0; + } + bool TestCaseInfo::throws() const { + return ( properties & Throws ) != 0; + } + bool TestCaseInfo::okToFail() const { + return ( properties & (ShouldFail | MayFail ) ) != 0; + } + bool TestCaseInfo::expectedToFail() const { + return ( properties & (ShouldFail ) ) != 0; + } + + TestCase::TestCase( ITestCase* testCase, TestCaseInfo const& info ) : TestCaseInfo( info ), test( testCase ) {} + + TestCase::TestCase( TestCase const& other ) + : TestCaseInfo( other ), + test( other.test ) + {} + + TestCase TestCase::withName( std::string const& _newName ) const { + TestCase other( *this ); + other.name = _newName; + return other; + } + + void TestCase::swap( TestCase& other ) { + test.swap( other.test ); + name.swap( other.name ); + className.swap( other.className ); + description.swap( other.description ); + tags.swap( other.tags ); + lcaseTags.swap( other.lcaseTags ); + tagsAsString.swap( other.tagsAsString ); + std::swap( TestCaseInfo::properties, static_cast( other ).properties ); + std::swap( lineInfo, other.lineInfo ); + } + + void TestCase::invoke() const { + test->invoke(); + } + + bool TestCase::operator == ( TestCase const& other ) const { + return test.get() == other.test.get() && + name == other.name && + className == other.className; + } + + bool TestCase::operator < ( TestCase const& other ) const { + return name < other.name; + } + TestCase& TestCase::operator = ( TestCase const& other ) { + TestCase temp( other ); + swap( temp ); + return *this; + } + + TestCaseInfo const& TestCase::getTestCaseInfo() const + { + return *this; + } + +} // end namespace Catch + +// #included from: catch_version.hpp +#define TWOBLUECUBES_CATCH_VERSION_HPP_INCLUDED + +namespace Catch { + + Version::Version + ( unsigned int _majorVersion, + unsigned int _minorVersion, + unsigned int _patchNumber, + std::string const& _branchName, + unsigned int _buildNumber ) + : majorVersion( _majorVersion ), + minorVersion( _minorVersion ), + patchNumber( _patchNumber ), + branchName( _branchName ), + buildNumber( _buildNumber ) + {} + + std::ostream& operator << ( std::ostream& os, Version const& version ) { + os << version.majorVersion << "." + << version.minorVersion << "." + << version.patchNumber; + + if( !version.branchName.empty() ) { + os << "-" << version.branchName + << "." << version.buildNumber; + } + return os; + } + + Version libraryVersion( 1, 4, 0, "", 0 ); + +} + +// #included from: catch_message.hpp +#define TWOBLUECUBES_CATCH_MESSAGE_HPP_INCLUDED + +namespace Catch { + + MessageInfo::MessageInfo( std::string const& _macroName, + SourceLineInfo const& _lineInfo, + ResultWas::OfType _type ) + : macroName( _macroName ), + lineInfo( _lineInfo ), + type( _type ), + sequence( ++globalCount ) + {} + + // This may need protecting if threading support is added + unsigned int MessageInfo::globalCount = 0; + + //////////////////////////////////////////////////////////////////////////// + + ScopedMessage::ScopedMessage( MessageBuilder const& builder ) + : m_info( builder.m_info ) + { + m_info.message = builder.m_stream.str(); + getResultCapture().pushScopedMessage( m_info ); + } + ScopedMessage::ScopedMessage( ScopedMessage const& other ) + : m_info( other.m_info ) + {} + + ScopedMessage::~ScopedMessage() { + getResultCapture().popScopedMessage( m_info ); + } + +} // end namespace Catch + +// #included from: catch_legacy_reporter_adapter.hpp +#define TWOBLUECUBES_CATCH_LEGACY_REPORTER_ADAPTER_HPP_INCLUDED + +// #included from: catch_legacy_reporter_adapter.h +#define TWOBLUECUBES_CATCH_LEGACY_REPORTER_ADAPTER_H_INCLUDED + +namespace Catch +{ + // Deprecated + struct IReporter : IShared { + virtual ~IReporter(); + + virtual bool shouldRedirectStdout() const = 0; + + virtual void StartTesting() = 0; + virtual void EndTesting( Totals const& totals ) = 0; + virtual void StartGroup( std::string const& groupName ) = 0; + virtual void EndGroup( std::string const& groupName, Totals const& totals ) = 0; + virtual void StartTestCase( TestCaseInfo const& testInfo ) = 0; + virtual void EndTestCase( TestCaseInfo const& testInfo, Totals const& totals, std::string const& stdOut, std::string const& stdErr ) = 0; + virtual void StartSection( std::string const& sectionName, std::string const& description ) = 0; + virtual void EndSection( std::string const& sectionName, Counts const& assertions ) = 0; + virtual void NoAssertionsInSection( std::string const& sectionName ) = 0; + virtual void NoAssertionsInTestCase( std::string const& testName ) = 0; + virtual void Aborted() = 0; + virtual void Result( AssertionResult const& result ) = 0; + }; + + class LegacyReporterAdapter : public SharedImpl + { + public: + LegacyReporterAdapter( Ptr const& legacyReporter ); + virtual ~LegacyReporterAdapter(); + + virtual ReporterPreferences getPreferences() const; + virtual void noMatchingTestCases( std::string const& ); + virtual void testRunStarting( TestRunInfo const& ); + virtual void testGroupStarting( GroupInfo const& groupInfo ); + virtual void testCaseStarting( TestCaseInfo const& testInfo ); + virtual void sectionStarting( SectionInfo const& sectionInfo ); + virtual void assertionStarting( AssertionInfo const& ); + virtual bool assertionEnded( AssertionStats const& assertionStats ); + virtual void sectionEnded( SectionStats const& sectionStats ); + virtual void testCaseEnded( TestCaseStats const& testCaseStats ); + virtual void testGroupEnded( TestGroupStats const& testGroupStats ); + virtual void testRunEnded( TestRunStats const& testRunStats ); + virtual void skipTest( TestCaseInfo const& ); + + private: + Ptr m_legacyReporter; + }; +} + +namespace Catch +{ + LegacyReporterAdapter::LegacyReporterAdapter( Ptr const& legacyReporter ) + : m_legacyReporter( legacyReporter ) + {} + LegacyReporterAdapter::~LegacyReporterAdapter() {} + + ReporterPreferences LegacyReporterAdapter::getPreferences() const { + ReporterPreferences prefs; + prefs.shouldRedirectStdOut = m_legacyReporter->shouldRedirectStdout(); + return prefs; + } + + void LegacyReporterAdapter::noMatchingTestCases( std::string const& ) {} + void LegacyReporterAdapter::testRunStarting( TestRunInfo const& ) { + m_legacyReporter->StartTesting(); + } + void LegacyReporterAdapter::testGroupStarting( GroupInfo const& groupInfo ) { + m_legacyReporter->StartGroup( groupInfo.name ); + } + void LegacyReporterAdapter::testCaseStarting( TestCaseInfo const& testInfo ) { + m_legacyReporter->StartTestCase( testInfo ); + } + void LegacyReporterAdapter::sectionStarting( SectionInfo const& sectionInfo ) { + m_legacyReporter->StartSection( sectionInfo.name, sectionInfo.description ); + } + void LegacyReporterAdapter::assertionStarting( AssertionInfo const& ) { + // Not on legacy interface + } + + bool LegacyReporterAdapter::assertionEnded( AssertionStats const& assertionStats ) { + if( assertionStats.assertionResult.getResultType() != ResultWas::Ok ) { + for( std::vector::const_iterator it = assertionStats.infoMessages.begin(), itEnd = assertionStats.infoMessages.end(); + it != itEnd; + ++it ) { + if( it->type == ResultWas::Info ) { + ResultBuilder rb( it->macroName.c_str(), it->lineInfo, "", ResultDisposition::Normal ); + rb << it->message; + rb.setResultType( ResultWas::Info ); + AssertionResult result = rb.build(); + m_legacyReporter->Result( result ); + } + } + } + m_legacyReporter->Result( assertionStats.assertionResult ); + return true; + } + void LegacyReporterAdapter::sectionEnded( SectionStats const& sectionStats ) { + if( sectionStats.missingAssertions ) + m_legacyReporter->NoAssertionsInSection( sectionStats.sectionInfo.name ); + m_legacyReporter->EndSection( sectionStats.sectionInfo.name, sectionStats.assertions ); + } + void LegacyReporterAdapter::testCaseEnded( TestCaseStats const& testCaseStats ) { + m_legacyReporter->EndTestCase + ( testCaseStats.testInfo, + testCaseStats.totals, + testCaseStats.stdOut, + testCaseStats.stdErr ); + } + void LegacyReporterAdapter::testGroupEnded( TestGroupStats const& testGroupStats ) { + if( testGroupStats.aborting ) + m_legacyReporter->Aborted(); + m_legacyReporter->EndGroup( testGroupStats.groupInfo.name, testGroupStats.totals ); + } + void LegacyReporterAdapter::testRunEnded( TestRunStats const& testRunStats ) { + m_legacyReporter->EndTesting( testRunStats.totals ); + } + void LegacyReporterAdapter::skipTest( TestCaseInfo const& ) { + } +} + +// #included from: catch_timer.hpp + +#ifdef __clang__ +#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wc++11-long-long" +#endif + +#ifdef CATCH_PLATFORM_WINDOWS +#include +#else +#include +#endif + +namespace Catch { + + namespace { +#ifdef CATCH_PLATFORM_WINDOWS + uint64_t getCurrentTicks() { + static uint64_t hz=0, hzo=0; + if (!hz) { + QueryPerformanceFrequency( reinterpret_cast( &hz ) ); + QueryPerformanceCounter( reinterpret_cast( &hzo ) ); + } + uint64_t t; + QueryPerformanceCounter( reinterpret_cast( &t ) ); + return ((t-hzo)*1000000)/hz; + } +#else + uint64_t getCurrentTicks() { + timeval t; + gettimeofday(&t,CATCH_NULL); + return static_cast( t.tv_sec ) * 1000000ull + static_cast( t.tv_usec ); + } +#endif + } + + void Timer::start() { + m_ticks = getCurrentTicks(); + } + unsigned int Timer::getElapsedMicroseconds() const { + return static_cast(getCurrentTicks() - m_ticks); + } + unsigned int Timer::getElapsedMilliseconds() const { + return static_cast(getElapsedMicroseconds()/1000); + } + double Timer::getElapsedSeconds() const { + return getElapsedMicroseconds()/1000000.0; + } + +} // namespace Catch + +#ifdef __clang__ +#pragma clang diagnostic pop +#endif +// #included from: catch_common.hpp +#define TWOBLUECUBES_CATCH_COMMON_HPP_INCLUDED + +namespace Catch { + + bool startsWith( std::string const& s, std::string const& prefix ) { + return s.size() >= prefix.size() && s.substr( 0, prefix.size() ) == prefix; + } + bool endsWith( std::string const& s, std::string const& suffix ) { + return s.size() >= suffix.size() && s.substr( s.size()-suffix.size(), suffix.size() ) == suffix; + } + bool contains( std::string const& s, std::string const& infix ) { + return s.find( infix ) != std::string::npos; + } + void toLowerInPlace( std::string& s ) { + std::transform( s.begin(), s.end(), s.begin(), ::tolower ); + } + std::string toLower( std::string const& s ) { + std::string lc = s; + toLowerInPlace( lc ); + return lc; + } + std::string trim( std::string const& str ) { + static char const* whitespaceChars = "\n\r\t "; + std::string::size_type start = str.find_first_not_of( whitespaceChars ); + std::string::size_type end = str.find_last_not_of( whitespaceChars ); + + return start != std::string::npos ? str.substr( start, 1+end-start ) : ""; + } + + bool replaceInPlace( std::string& str, std::string const& replaceThis, std::string const& withThis ) { + bool replaced = false; + std::size_t i = str.find( replaceThis ); + while( i != std::string::npos ) { + replaced = true; + str = str.substr( 0, i ) + withThis + str.substr( i+replaceThis.size() ); + if( i < str.size()-withThis.size() ) + i = str.find( replaceThis, i+withThis.size() ); + else + i = std::string::npos; + } + return replaced; + } + + pluralise::pluralise( std::size_t count, std::string const& label ) + : m_count( count ), + m_label( label ) + {} + + std::ostream& operator << ( std::ostream& os, pluralise const& pluraliser ) { + os << pluraliser.m_count << " " << pluraliser.m_label; + if( pluraliser.m_count != 1 ) + os << "s"; + return os; + } + + SourceLineInfo::SourceLineInfo() : line( 0 ){} + SourceLineInfo::SourceLineInfo( char const* _file, std::size_t _line ) + : file( _file ), + line( _line ) + {} + SourceLineInfo::SourceLineInfo( SourceLineInfo const& other ) + : file( other.file ), + line( other.line ) + {} + bool SourceLineInfo::empty() const { + return file.empty(); + } + bool SourceLineInfo::operator == ( SourceLineInfo const& other ) const { + return line == other.line && file == other.file; + } + bool SourceLineInfo::operator < ( SourceLineInfo const& other ) const { + return line < other.line || ( line == other.line && file < other.file ); + } + + void seedRng( IConfig const& config ) { + if( config.rngSeed() != 0 ) + std::srand( config.rngSeed() ); + } + unsigned int rngSeed() { + return getCurrentContext().getConfig()->rngSeed(); + } + + std::ostream& operator << ( std::ostream& os, SourceLineInfo const& info ) { +#ifndef __GNUG__ + os << info.file << "(" << info.line << ")"; +#else + os << info.file << ":" << info.line; +#endif + return os; + } + + void throwLogicError( std::string const& message, SourceLineInfo const& locationInfo ) { + std::ostringstream oss; + oss << locationInfo << ": Internal Catch error: '" << message << "'"; + if( alwaysTrue() ) + throw std::logic_error( oss.str() ); + } +} + +// #included from: catch_section.hpp +#define TWOBLUECUBES_CATCH_SECTION_HPP_INCLUDED + +namespace Catch { + + SectionInfo::SectionInfo + ( SourceLineInfo const& _lineInfo, + std::string const& _name, + std::string const& _description ) + : name( _name ), + description( _description ), + lineInfo( _lineInfo ) + {} + + Section::Section( SectionInfo const& info ) + : m_info( info ), + m_sectionIncluded( getResultCapture().sectionStarted( m_info, m_assertions ) ) + { + m_timer.start(); + } + + Section::~Section() { + if( m_sectionIncluded ) { + SectionEndInfo endInfo( m_info, m_assertions, m_timer.getElapsedSeconds() ); + if( std::uncaught_exception() ) + getResultCapture().sectionEndedEarly( endInfo ); + else + getResultCapture().sectionEnded( endInfo ); + } + } + + // This indicates whether the section should be executed or not + Section::operator bool() const { + return m_sectionIncluded; + } + +} // end namespace Catch + +// #included from: catch_debugger.hpp +#define TWOBLUECUBES_CATCH_DEBUGGER_HPP_INCLUDED + +#include + +#ifdef CATCH_PLATFORM_MAC + + #include + #include + #include + #include + #include + + namespace Catch{ + + // The following function is taken directly from the following technical note: + // http://developer.apple.com/library/mac/#qa/qa2004/qa1361.html + + // Returns true if the current process is being debugged (either + // running under the debugger or has a debugger attached post facto). + bool isDebuggerActive(){ + + int mib[4]; + struct kinfo_proc info; + size_t size; + + // Initialize the flags so that, if sysctl fails for some bizarre + // reason, we get a predictable result. + + info.kp_proc.p_flag = 0; + + // Initialize mib, which tells sysctl the info we want, in this case + // we're looking for information about a specific process ID. + + mib[0] = CTL_KERN; + mib[1] = KERN_PROC; + mib[2] = KERN_PROC_PID; + mib[3] = getpid(); + + // Call sysctl. + + size = sizeof(info); + if( sysctl(mib, sizeof(mib) / sizeof(*mib), &info, &size, CATCH_NULL, 0) != 0 ) { + Catch::cerr() << "\n** Call to sysctl failed - unable to determine if debugger is active **\n" << std::endl; + return false; + } + + // We're being debugged if the P_TRACED flag is set. + + return ( (info.kp_proc.p_flag & P_TRACED) != 0 ); + } + } // namespace Catch + +#elif defined(_MSC_VER) + extern "C" __declspec(dllimport) int __stdcall IsDebuggerPresent(); + namespace Catch { + bool isDebuggerActive() { + return IsDebuggerPresent() != 0; + } + } +#elif defined(__MINGW32__) + extern "C" __declspec(dllimport) int __stdcall IsDebuggerPresent(); + namespace Catch { + bool isDebuggerActive() { + return IsDebuggerPresent() != 0; + } + } +#else + namespace Catch { + inline bool isDebuggerActive() { return false; } + } +#endif // Platform + +#ifdef CATCH_PLATFORM_WINDOWS + extern "C" __declspec(dllimport) void __stdcall OutputDebugStringA( const char* ); + namespace Catch { + void writeToDebugConsole( std::string const& text ) { + ::OutputDebugStringA( text.c_str() ); + } + } +#else + namespace Catch { + void writeToDebugConsole( std::string const& text ) { + // !TBD: Need a version for Mac/ XCode and other IDEs + Catch::cout() << text; + } + } +#endif // Platform + +// #included from: catch_tostring.hpp +#define TWOBLUECUBES_CATCH_TOSTRING_HPP_INCLUDED + +namespace Catch { + +namespace Detail { + + const std::string unprintableString = "{?}"; + + namespace { + const int hexThreshold = 255; + + struct Endianness { + enum Arch { Big, Little }; + + static Arch which() { + union _{ + int asInt; + char asChar[sizeof (int)]; + } u; + + u.asInt = 1; + return ( u.asChar[sizeof(int)-1] == 1 ) ? Big : Little; + } + }; + } + + std::string rawMemoryToString( const void *object, std::size_t size ) + { + // Reverse order for little endian architectures + int i = 0, end = static_cast( size ), inc = 1; + if( Endianness::which() == Endianness::Little ) { + i = end-1; + end = inc = -1; + } + + unsigned char const *bytes = static_cast(object); + std::ostringstream os; + os << "0x" << std::setfill('0') << std::hex; + for( ; i != end; i += inc ) + os << std::setw(2) << static_cast(bytes[i]); + return os.str(); + } +} + +std::string toString( std::string const& value ) { + std::string s = value; + if( getCurrentContext().getConfig()->showInvisibles() ) { + for(size_t i = 0; i < s.size(); ++i ) { + std::string subs; + switch( s[i] ) { + case '\n': subs = "\\n"; break; + case '\t': subs = "\\t"; break; + default: break; + } + if( !subs.empty() ) { + s = s.substr( 0, i ) + subs + s.substr( i+1 ); + ++i; + } + } + } + return "\"" + s + "\""; +} +std::string toString( std::wstring const& value ) { + + std::string s; + s.reserve( value.size() ); + for(size_t i = 0; i < value.size(); ++i ) + s += value[i] <= 0xff ? static_cast( value[i] ) : '?'; + return Catch::toString( s ); +} + +std::string toString( const char* const value ) { + return value ? Catch::toString( std::string( value ) ) : std::string( "{null string}" ); +} + +std::string toString( char* const value ) { + return Catch::toString( static_cast( value ) ); +} + +std::string toString( const wchar_t* const value ) +{ + return value ? Catch::toString( std::wstring(value) ) : std::string( "{null string}" ); +} + +std::string toString( wchar_t* const value ) +{ + return Catch::toString( static_cast( value ) ); +} + +std::string toString( int value ) { + std::ostringstream oss; + oss << value; + if( value > Detail::hexThreshold ) + oss << " (0x" << std::hex << value << ")"; + return oss.str(); +} + +std::string toString( unsigned long value ) { + std::ostringstream oss; + oss << value; + if( value > Detail::hexThreshold ) + oss << " (0x" << std::hex << value << ")"; + return oss.str(); +} + +std::string toString( unsigned int value ) { + return Catch::toString( static_cast( value ) ); +} + +template +std::string fpToString( T value, int precision ) { + std::ostringstream oss; + oss << std::setprecision( precision ) + << std::fixed + << value; + std::string d = oss.str(); + std::size_t i = d.find_last_not_of( '0' ); + if( i != std::string::npos && i != d.size()-1 ) { + if( d[i] == '.' ) + i++; + d = d.substr( 0, i+1 ); + } + return d; +} + +std::string toString( const double value ) { + return fpToString( value, 10 ); +} +std::string toString( const float value ) { + return fpToString( value, 5 ) + "f"; +} + +std::string toString( bool value ) { + return value ? "true" : "false"; +} + +std::string toString( char value ) { + return value < ' ' + ? toString( static_cast( value ) ) + : Detail::makeString( value ); +} + +std::string toString( signed char value ) { + return toString( static_cast( value ) ); +} + +std::string toString( unsigned char value ) { + return toString( static_cast( value ) ); +} + +#ifdef CATCH_CONFIG_CPP11_LONG_LONG +std::string toString( long long value ) { + std::ostringstream oss; + oss << value; + if( value > Detail::hexThreshold ) + oss << " (0x" << std::hex << value << ")"; + return oss.str(); +} +std::string toString( unsigned long long value ) { + std::ostringstream oss; + oss << value; + if( value > Detail::hexThreshold ) + oss << " (0x" << std::hex << value << ")"; + return oss.str(); +} +#endif + +#ifdef CATCH_CONFIG_CPP11_NULLPTR +std::string toString( std::nullptr_t ) { + return "nullptr"; +} +#endif + +#ifdef __OBJC__ + std::string toString( NSString const * const& nsstring ) { + if( !nsstring ) + return "nil"; + return "@" + toString([nsstring UTF8String]); + } + std::string toString( NSString * CATCH_ARC_STRONG const& nsstring ) { + if( !nsstring ) + return "nil"; + return "@" + toString([nsstring UTF8String]); + } + std::string toString( NSObject* const& nsObject ) { + return toString( [nsObject description] ); + } +#endif + +} // end namespace Catch + +// #included from: catch_result_builder.hpp +#define TWOBLUECUBES_CATCH_RESULT_BUILDER_HPP_INCLUDED + +namespace Catch { + + std::string capturedExpressionWithSecondArgument( std::string const& capturedExpression, std::string const& secondArg ) { + return secondArg.empty() || secondArg == "\"\"" + ? capturedExpression + : capturedExpression + ", " + secondArg; + } + ResultBuilder::ResultBuilder( char const* macroName, + SourceLineInfo const& lineInfo, + char const* capturedExpression, + ResultDisposition::Flags resultDisposition, + char const* secondArg ) + : m_assertionInfo( macroName, lineInfo, capturedExpressionWithSecondArgument( capturedExpression, secondArg ), resultDisposition ), + m_shouldDebugBreak( false ), + m_shouldThrow( false ) + {} + + ResultBuilder& ResultBuilder::setResultType( ResultWas::OfType result ) { + m_data.resultType = result; + return *this; + } + ResultBuilder& ResultBuilder::setResultType( bool result ) { + m_data.resultType = result ? ResultWas::Ok : ResultWas::ExpressionFailed; + return *this; + } + ResultBuilder& ResultBuilder::setLhs( std::string const& lhs ) { + m_exprComponents.lhs = lhs; + return *this; + } + ResultBuilder& ResultBuilder::setRhs( std::string const& rhs ) { + m_exprComponents.rhs = rhs; + return *this; + } + ResultBuilder& ResultBuilder::setOp( std::string const& op ) { + m_exprComponents.op = op; + return *this; + } + + void ResultBuilder::endExpression() { + m_exprComponents.testFalse = isFalseTest( m_assertionInfo.resultDisposition ); + captureExpression(); + } + + void ResultBuilder::useActiveException( ResultDisposition::Flags resultDisposition ) { + m_assertionInfo.resultDisposition = resultDisposition; + m_stream.oss << Catch::translateActiveException(); + captureResult( ResultWas::ThrewException ); + } + + void ResultBuilder::captureResult( ResultWas::OfType resultType ) { + setResultType( resultType ); + captureExpression(); + } + void ResultBuilder::captureExpectedException( std::string const& expectedMessage ) { + if( expectedMessage.empty() ) + captureExpectedException( Matchers::Impl::Generic::AllOf() ); + else + captureExpectedException( Matchers::Equals( expectedMessage ) ); + } + + void ResultBuilder::captureExpectedException( Matchers::Impl::Matcher const& matcher ) { + + assert( m_exprComponents.testFalse == false ); + AssertionResultData data = m_data; + data.resultType = ResultWas::Ok; + data.reconstructedExpression = m_assertionInfo.capturedExpression; + + std::string actualMessage = Catch::translateActiveException(); + if( !matcher.match( actualMessage ) ) { + data.resultType = ResultWas::ExpressionFailed; + data.reconstructedExpression = actualMessage; + } + AssertionResult result( m_assertionInfo, data ); + handleResult( result ); + } + + void ResultBuilder::captureExpression() { + AssertionResult result = build(); + handleResult( result ); + } + void ResultBuilder::handleResult( AssertionResult const& result ) + { + getResultCapture().assertionEnded( result ); + + if( !result.isOk() ) { + if( getCurrentContext().getConfig()->shouldDebugBreak() ) + m_shouldDebugBreak = true; + if( getCurrentContext().getRunner()->aborting() || (m_assertionInfo.resultDisposition & ResultDisposition::Normal) ) + m_shouldThrow = true; + } + } + void ResultBuilder::react() { + if( m_shouldThrow ) + throw Catch::TestFailureException(); + } + + bool ResultBuilder::shouldDebugBreak() const { return m_shouldDebugBreak; } + bool ResultBuilder::allowThrows() const { return getCurrentContext().getConfig()->allowThrows(); } + + AssertionResult ResultBuilder::build() const + { + assert( m_data.resultType != ResultWas::Unknown ); + + AssertionResultData data = m_data; + + // Flip bool results if testFalse is set + if( m_exprComponents.testFalse ) { + if( data.resultType == ResultWas::Ok ) + data.resultType = ResultWas::ExpressionFailed; + else if( data.resultType == ResultWas::ExpressionFailed ) + data.resultType = ResultWas::Ok; + } + + data.message = m_stream.oss.str(); + data.reconstructedExpression = reconstructExpression(); + if( m_exprComponents.testFalse ) { + if( m_exprComponents.op == "" ) + data.reconstructedExpression = "!" + data.reconstructedExpression; + else + data.reconstructedExpression = "!(" + data.reconstructedExpression + ")"; + } + return AssertionResult( m_assertionInfo, data ); + } + std::string ResultBuilder::reconstructExpression() const { + if( m_exprComponents.op == "" ) + return m_exprComponents.lhs.empty() ? m_assertionInfo.capturedExpression : m_exprComponents.op + m_exprComponents.lhs; + else if( m_exprComponents.op == "matches" ) + return m_exprComponents.lhs + " " + m_exprComponents.rhs; + else if( m_exprComponents.op != "!" ) { + if( m_exprComponents.lhs.size() + m_exprComponents.rhs.size() < 40 && + m_exprComponents.lhs.find("\n") == std::string::npos && + m_exprComponents.rhs.find("\n") == std::string::npos ) + return m_exprComponents.lhs + " " + m_exprComponents.op + " " + m_exprComponents.rhs; + else + return m_exprComponents.lhs + "\n" + m_exprComponents.op + "\n" + m_exprComponents.rhs; + } + else + return "{can't expand - use " + m_assertionInfo.macroName + "_FALSE( " + m_assertionInfo.capturedExpression.substr(1) + " ) instead of " + m_assertionInfo.macroName + "( " + m_assertionInfo.capturedExpression + " ) for better diagnostics}"; + } + +} // end namespace Catch + +// #included from: catch_tag_alias_registry.hpp +#define TWOBLUECUBES_CATCH_TAG_ALIAS_REGISTRY_HPP_INCLUDED + +// #included from: catch_tag_alias_registry.h +#define TWOBLUECUBES_CATCH_TAG_ALIAS_REGISTRY_H_INCLUDED + +#include + +namespace Catch { + + class TagAliasRegistry : public ITagAliasRegistry { + public: + virtual ~TagAliasRegistry(); + virtual Option find( std::string const& alias ) const; + virtual std::string expandAliases( std::string const& unexpandedTestSpec ) const; + void add( char const* alias, char const* tag, SourceLineInfo const& lineInfo ); + static TagAliasRegistry& get(); + + private: + std::map m_registry; + }; + +} // end namespace Catch + +#include +#include + +namespace Catch { + + TagAliasRegistry::~TagAliasRegistry() {} + + Option TagAliasRegistry::find( std::string const& alias ) const { + std::map::const_iterator it = m_registry.find( alias ); + if( it != m_registry.end() ) + return it->second; + else + return Option(); + } + + std::string TagAliasRegistry::expandAliases( std::string const& unexpandedTestSpec ) const { + std::string expandedTestSpec = unexpandedTestSpec; + for( std::map::const_iterator it = m_registry.begin(), itEnd = m_registry.end(); + it != itEnd; + ++it ) { + std::size_t pos = expandedTestSpec.find( it->first ); + if( pos != std::string::npos ) { + expandedTestSpec = expandedTestSpec.substr( 0, pos ) + + it->second.tag + + expandedTestSpec.substr( pos + it->first.size() ); + } + } + return expandedTestSpec; + } + + void TagAliasRegistry::add( char const* alias, char const* tag, SourceLineInfo const& lineInfo ) { + + if( !startsWith( alias, "[@" ) || !endsWith( alias, "]" ) ) { + std::ostringstream oss; + oss << "error: tag alias, \"" << alias << "\" is not of the form [@alias name].\n" << lineInfo; + throw std::domain_error( oss.str().c_str() ); + } + if( !m_registry.insert( std::make_pair( alias, TagAlias( tag, lineInfo ) ) ).second ) { + std::ostringstream oss; + oss << "error: tag alias, \"" << alias << "\" already registered.\n" + << "\tFirst seen at " << find(alias)->lineInfo << "\n" + << "\tRedefined at " << lineInfo; + throw std::domain_error( oss.str().c_str() ); + } + } + + TagAliasRegistry& TagAliasRegistry::get() { + static TagAliasRegistry instance; + return instance; + + } + + ITagAliasRegistry::~ITagAliasRegistry() {} + ITagAliasRegistry const& ITagAliasRegistry::get() { return TagAliasRegistry::get(); } + + RegistrarForTagAliases::RegistrarForTagAliases( char const* alias, char const* tag, SourceLineInfo const& lineInfo ) { + try { + TagAliasRegistry::get().add( alias, tag, lineInfo ); + } + catch( std::exception& ex ) { + Colour colourGuard( Colour::Red ); + Catch::cerr() << ex.what() << std::endl; + exit(1); + } + } + +} // end namespace Catch + +// #included from: ../reporters/catch_reporter_multi.hpp +#define TWOBLUECUBES_CATCH_REPORTER_MULTI_HPP_INCLUDED + +namespace Catch { + +class MultipleReporters : public SharedImpl { + typedef std::vector > Reporters; + Reporters m_reporters; + +public: + void add( Ptr const& reporter ) { + m_reporters.push_back( reporter ); + } + +public: // IStreamingReporter + + virtual ReporterPreferences getPreferences() const CATCH_OVERRIDE { + return m_reporters[0]->getPreferences(); + } + + virtual void noMatchingTestCases( std::string const& spec ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->noMatchingTestCases( spec ); + } + + virtual void testRunStarting( TestRunInfo const& testRunInfo ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->testRunStarting( testRunInfo ); + } + + virtual void testGroupStarting( GroupInfo const& groupInfo ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->testGroupStarting( groupInfo ); + } + + virtual void testCaseStarting( TestCaseInfo const& testInfo ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->testCaseStarting( testInfo ); + } + + virtual void sectionStarting( SectionInfo const& sectionInfo ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->sectionStarting( sectionInfo ); + } + + virtual void assertionStarting( AssertionInfo const& assertionInfo ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->assertionStarting( assertionInfo ); + } + + // The return value indicates if the messages buffer should be cleared: + virtual bool assertionEnded( AssertionStats const& assertionStats ) CATCH_OVERRIDE { + bool clearBuffer = false; + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + clearBuffer |= (*it)->assertionEnded( assertionStats ); + return clearBuffer; + } + + virtual void sectionEnded( SectionStats const& sectionStats ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->sectionEnded( sectionStats ); + } + + virtual void testCaseEnded( TestCaseStats const& testCaseStats ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->testCaseEnded( testCaseStats ); + } + + virtual void testGroupEnded( TestGroupStats const& testGroupStats ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->testGroupEnded( testGroupStats ); + } + + virtual void testRunEnded( TestRunStats const& testRunStats ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->testRunEnded( testRunStats ); + } + + virtual void skipTest( TestCaseInfo const& testInfo ) CATCH_OVERRIDE { + for( Reporters::const_iterator it = m_reporters.begin(), itEnd = m_reporters.end(); + it != itEnd; + ++it ) + (*it)->skipTest( testInfo ); + } +}; + +Ptr addReporter( Ptr const& existingReporter, Ptr const& additionalReporter ) { + Ptr resultingReporter; + + if( existingReporter ) { + MultipleReporters* multi = dynamic_cast( existingReporter.get() ); + if( !multi ) { + multi = new MultipleReporters; + resultingReporter = Ptr( multi ); + if( existingReporter ) + multi->add( existingReporter ); + } + else + resultingReporter = existingReporter; + multi->add( additionalReporter ); + } + else + resultingReporter = additionalReporter; + + return resultingReporter; +} + +} // end namespace Catch + +// #included from: ../reporters/catch_reporter_xml.hpp +#define TWOBLUECUBES_CATCH_REPORTER_XML_HPP_INCLUDED + +// #included from: catch_reporter_bases.hpp +#define TWOBLUECUBES_CATCH_REPORTER_BASES_HPP_INCLUDED + +#include + +namespace Catch { + + struct StreamingReporterBase : SharedImpl { + + StreamingReporterBase( ReporterConfig const& _config ) + : m_config( _config.fullConfig() ), + stream( _config.stream() ) + { + m_reporterPrefs.shouldRedirectStdOut = false; + } + + virtual ReporterPreferences getPreferences() const CATCH_OVERRIDE { + return m_reporterPrefs; + } + + virtual ~StreamingReporterBase() CATCH_OVERRIDE; + + virtual void noMatchingTestCases( std::string const& ) CATCH_OVERRIDE {} + + virtual void testRunStarting( TestRunInfo const& _testRunInfo ) CATCH_OVERRIDE { + currentTestRunInfo = _testRunInfo; + } + virtual void testGroupStarting( GroupInfo const& _groupInfo ) CATCH_OVERRIDE { + currentGroupInfo = _groupInfo; + } + + virtual void testCaseStarting( TestCaseInfo const& _testInfo ) CATCH_OVERRIDE { + currentTestCaseInfo = _testInfo; + } + virtual void sectionStarting( SectionInfo const& _sectionInfo ) CATCH_OVERRIDE { + m_sectionStack.push_back( _sectionInfo ); + } + + virtual void sectionEnded( SectionStats const& /* _sectionStats */ ) CATCH_OVERRIDE { + m_sectionStack.pop_back(); + } + virtual void testCaseEnded( TestCaseStats const& /* _testCaseStats */ ) CATCH_OVERRIDE { + currentTestCaseInfo.reset(); + } + virtual void testGroupEnded( TestGroupStats const& /* _testGroupStats */ ) CATCH_OVERRIDE { + currentGroupInfo.reset(); + } + virtual void testRunEnded( TestRunStats const& /* _testRunStats */ ) CATCH_OVERRIDE { + currentTestCaseInfo.reset(); + currentGroupInfo.reset(); + currentTestRunInfo.reset(); + } + + virtual void skipTest( TestCaseInfo const& ) CATCH_OVERRIDE { + // Don't do anything with this by default. + // It can optionally be overridden in the derived class. + } + + Ptr m_config; + std::ostream& stream; + + LazyStat currentTestRunInfo; + LazyStat currentGroupInfo; + LazyStat currentTestCaseInfo; + + std::vector m_sectionStack; + ReporterPreferences m_reporterPrefs; + }; + + struct CumulativeReporterBase : SharedImpl { + template + struct Node : SharedImpl<> { + explicit Node( T const& _value ) : value( _value ) {} + virtual ~Node() {} + + typedef std::vector > ChildNodes; + T value; + ChildNodes children; + }; + struct SectionNode : SharedImpl<> { + explicit SectionNode( SectionStats const& _stats ) : stats( _stats ) {} + virtual ~SectionNode(); + + bool operator == ( SectionNode const& other ) const { + return stats.sectionInfo.lineInfo == other.stats.sectionInfo.lineInfo; + } + bool operator == ( Ptr const& other ) const { + return operator==( *other ); + } + + SectionStats stats; + typedef std::vector > ChildSections; + typedef std::vector Assertions; + ChildSections childSections; + Assertions assertions; + std::string stdOut; + std::string stdErr; + }; + + struct BySectionInfo { + BySectionInfo( SectionInfo const& other ) : m_other( other ) {} + BySectionInfo( BySectionInfo const& other ) : m_other( other.m_other ) {} + bool operator() ( Ptr const& node ) const { + return node->stats.sectionInfo.lineInfo == m_other.lineInfo; + } + private: + void operator=( BySectionInfo const& ); + SectionInfo const& m_other; + }; + + typedef Node TestCaseNode; + typedef Node TestGroupNode; + typedef Node TestRunNode; + + CumulativeReporterBase( ReporterConfig const& _config ) + : m_config( _config.fullConfig() ), + stream( _config.stream() ) + { + m_reporterPrefs.shouldRedirectStdOut = false; + } + ~CumulativeReporterBase(); + + virtual ReporterPreferences getPreferences() const CATCH_OVERRIDE { + return m_reporterPrefs; + } + + virtual void testRunStarting( TestRunInfo const& ) CATCH_OVERRIDE {} + virtual void testGroupStarting( GroupInfo const& ) CATCH_OVERRIDE {} + + virtual void testCaseStarting( TestCaseInfo const& ) CATCH_OVERRIDE {} + + virtual void sectionStarting( SectionInfo const& sectionInfo ) CATCH_OVERRIDE { + SectionStats incompleteStats( sectionInfo, Counts(), 0, false ); + Ptr node; + if( m_sectionStack.empty() ) { + if( !m_rootSection ) + m_rootSection = new SectionNode( incompleteStats ); + node = m_rootSection; + } + else { + SectionNode& parentNode = *m_sectionStack.back(); + SectionNode::ChildSections::const_iterator it = + std::find_if( parentNode.childSections.begin(), + parentNode.childSections.end(), + BySectionInfo( sectionInfo ) ); + if( it == parentNode.childSections.end() ) { + node = new SectionNode( incompleteStats ); + parentNode.childSections.push_back( node ); + } + else + node = *it; + } + m_sectionStack.push_back( node ); + m_deepestSection = node; + } + + virtual void assertionStarting( AssertionInfo const& ) CATCH_OVERRIDE {} + + virtual bool assertionEnded( AssertionStats const& assertionStats ) { + assert( !m_sectionStack.empty() ); + SectionNode& sectionNode = *m_sectionStack.back(); + sectionNode.assertions.push_back( assertionStats ); + return true; + } + virtual void sectionEnded( SectionStats const& sectionStats ) CATCH_OVERRIDE { + assert( !m_sectionStack.empty() ); + SectionNode& node = *m_sectionStack.back(); + node.stats = sectionStats; + m_sectionStack.pop_back(); + } + virtual void testCaseEnded( TestCaseStats const& testCaseStats ) CATCH_OVERRIDE { + Ptr node = new TestCaseNode( testCaseStats ); + assert( m_sectionStack.size() == 0 ); + node->children.push_back( m_rootSection ); + m_testCases.push_back( node ); + m_rootSection.reset(); + + assert( m_deepestSection ); + m_deepestSection->stdOut = testCaseStats.stdOut; + m_deepestSection->stdErr = testCaseStats.stdErr; + } + virtual void testGroupEnded( TestGroupStats const& testGroupStats ) CATCH_OVERRIDE { + Ptr node = new TestGroupNode( testGroupStats ); + node->children.swap( m_testCases ); + m_testGroups.push_back( node ); + } + virtual void testRunEnded( TestRunStats const& testRunStats ) CATCH_OVERRIDE { + Ptr node = new TestRunNode( testRunStats ); + node->children.swap( m_testGroups ); + m_testRuns.push_back( node ); + testRunEndedCumulative(); + } + virtual void testRunEndedCumulative() = 0; + + virtual void skipTest( TestCaseInfo const& ) CATCH_OVERRIDE {} + + Ptr m_config; + std::ostream& stream; + std::vector m_assertions; + std::vector > > m_sections; + std::vector > m_testCases; + std::vector > m_testGroups; + + std::vector > m_testRuns; + + Ptr m_rootSection; + Ptr m_deepestSection; + std::vector > m_sectionStack; + ReporterPreferences m_reporterPrefs; + + }; + + template + char const* getLineOfChars() { + static char line[CATCH_CONFIG_CONSOLE_WIDTH] = {0}; + if( !*line ) { + memset( line, C, CATCH_CONFIG_CONSOLE_WIDTH-1 ); + line[CATCH_CONFIG_CONSOLE_WIDTH-1] = 0; + } + return line; + } + + struct TestEventListenerBase : StreamingReporterBase { + TestEventListenerBase( ReporterConfig const& _config ) + : StreamingReporterBase( _config ) + {} + + virtual void assertionStarting( AssertionInfo const& ) CATCH_OVERRIDE {} + virtual bool assertionEnded( AssertionStats const& ) CATCH_OVERRIDE { + return false; + } + }; + +} // end namespace Catch + +// #included from: ../internal/catch_reporter_registrars.hpp +#define TWOBLUECUBES_CATCH_REPORTER_REGISTRARS_HPP_INCLUDED + +namespace Catch { + + template + class LegacyReporterRegistrar { + + class ReporterFactory : public IReporterFactory { + virtual IStreamingReporter* create( ReporterConfig const& config ) const { + return new LegacyReporterAdapter( new T( config ) ); + } + + virtual std::string getDescription() const { + return T::getDescription(); + } + }; + + public: + + LegacyReporterRegistrar( std::string const& name ) { + getMutableRegistryHub().registerReporter( name, new ReporterFactory() ); + } + }; + + template + class ReporterRegistrar { + + class ReporterFactory : public SharedImpl { + + // *** Please Note ***: + // - If you end up here looking at a compiler error because it's trying to register + // your custom reporter class be aware that the native reporter interface has changed + // to IStreamingReporter. The "legacy" interface, IReporter, is still supported via + // an adapter. Just use REGISTER_LEGACY_REPORTER to take advantage of the adapter. + // However please consider updating to the new interface as the old one is now + // deprecated and will probably be removed quite soon! + // Please contact me via github if you have any questions at all about this. + // In fact, ideally, please contact me anyway to let me know you've hit this - as I have + // no idea who is actually using custom reporters at all (possibly no-one!). + // The new interface is designed to minimise exposure to interface changes in the future. + virtual IStreamingReporter* create( ReporterConfig const& config ) const { + return new T( config ); + } + + virtual std::string getDescription() const { + return T::getDescription(); + } + }; + + public: + + ReporterRegistrar( std::string const& name ) { + getMutableRegistryHub().registerReporter( name, new ReporterFactory() ); + } + }; + + template + class ListenerRegistrar { + + class ListenerFactory : public SharedImpl { + + virtual IStreamingReporter* create( ReporterConfig const& config ) const { + return new T( config ); + } + virtual std::string getDescription() const { + return ""; + } + }; + + public: + + ListenerRegistrar() { + getMutableRegistryHub().registerListener( new ListenerFactory() ); + } + }; +} + +#define INTERNAL_CATCH_REGISTER_LEGACY_REPORTER( name, reporterType ) \ + namespace{ Catch::LegacyReporterRegistrar catch_internal_RegistrarFor##reporterType( name ); } + +#define INTERNAL_CATCH_REGISTER_REPORTER( name, reporterType ) \ + namespace{ Catch::ReporterRegistrar catch_internal_RegistrarFor##reporterType( name ); } + +#define INTERNAL_CATCH_REGISTER_LISTENER( listenerType ) \ + namespace{ Catch::ListenerRegistrar catch_internal_RegistrarFor##listenerType; } + +// #included from: ../internal/catch_xmlwriter.hpp +#define TWOBLUECUBES_CATCH_XMLWRITER_HPP_INCLUDED + +#include +#include +#include +#include + +namespace Catch { + + class XmlEncode { + public: + enum ForWhat { ForTextNodes, ForAttributes }; + + XmlEncode( std::string const& str, ForWhat forWhat = ForTextNodes ) + : m_str( str ), + m_forWhat( forWhat ) + {} + + void encodeTo( std::ostream& os ) const { + + // Apostrophe escaping not necessary if we always use " to write attributes + // (see: http://www.w3.org/TR/xml/#syntax) + + for( std::size_t i = 0; i < m_str.size(); ++ i ) { + char c = m_str[i]; + switch( c ) { + case '<': os << "<"; break; + case '&': os << "&"; break; + + case '>': + // See: http://www.w3.org/TR/xml/#syntax + if( i > 2 && m_str[i-1] == ']' && m_str[i-2] == ']' ) + os << ">"; + else + os << c; + break; + + case '\"': + if( m_forWhat == ForAttributes ) + os << """; + else + os << c; + break; + + default: + // Escape control chars - based on contribution by @espenalb in PR #465 + if ( ( c < '\x09' ) || ( c > '\x0D' && c < '\x20') || c=='\x7F' ) + os << "&#x" << std::uppercase << std::hex << static_cast( c ); + else + os << c; + } + } + } + + friend std::ostream& operator << ( std::ostream& os, XmlEncode const& xmlEncode ) { + xmlEncode.encodeTo( os ); + return os; + } + + private: + std::string m_str; + ForWhat m_forWhat; + }; + + class XmlWriter { + public: + + class ScopedElement { + public: + ScopedElement( XmlWriter* writer ) + : m_writer( writer ) + {} + + ScopedElement( ScopedElement const& other ) + : m_writer( other.m_writer ){ + other.m_writer = CATCH_NULL; + } + + ~ScopedElement() { + if( m_writer ) + m_writer->endElement(); + } + + ScopedElement& writeText( std::string const& text, bool indent = true ) { + m_writer->writeText( text, indent ); + return *this; + } + + template + ScopedElement& writeAttribute( std::string const& name, T const& attribute ) { + m_writer->writeAttribute( name, attribute ); + return *this; + } + + private: + mutable XmlWriter* m_writer; + }; + + XmlWriter() + : m_tagIsOpen( false ), + m_needsNewline( false ), + m_os( &Catch::cout() ) + {} + + XmlWriter( std::ostream& os ) + : m_tagIsOpen( false ), + m_needsNewline( false ), + m_os( &os ) + {} + + ~XmlWriter() { + while( !m_tags.empty() ) + endElement(); + } + + XmlWriter& startElement( std::string const& name ) { + ensureTagClosed(); + newlineIfNecessary(); + stream() << m_indent << "<" << name; + m_tags.push_back( name ); + m_indent += " "; + m_tagIsOpen = true; + return *this; + } + + ScopedElement scopedElement( std::string const& name ) { + ScopedElement scoped( this ); + startElement( name ); + return scoped; + } + + XmlWriter& endElement() { + newlineIfNecessary(); + m_indent = m_indent.substr( 0, m_indent.size()-2 ); + if( m_tagIsOpen ) { + stream() << "/>\n"; + m_tagIsOpen = false; + } + else { + stream() << m_indent << "\n"; + } + m_tags.pop_back(); + return *this; + } + + XmlWriter& writeAttribute( std::string const& name, std::string const& attribute ) { + if( !name.empty() && !attribute.empty() ) + stream() << " " << name << "=\"" << XmlEncode( attribute, XmlEncode::ForAttributes ) << "\""; + return *this; + } + + XmlWriter& writeAttribute( std::string const& name, bool attribute ) { + stream() << " " << name << "=\"" << ( attribute ? "true" : "false" ) << "\""; + return *this; + } + + template + XmlWriter& writeAttribute( std::string const& name, T const& attribute ) { + std::ostringstream oss; + oss << attribute; + return writeAttribute( name, oss.str() ); + } + + XmlWriter& writeText( std::string const& text, bool indent = true ) { + if( !text.empty() ){ + bool tagWasOpen = m_tagIsOpen; + ensureTagClosed(); + if( tagWasOpen && indent ) + stream() << m_indent; + stream() << XmlEncode( text ); + m_needsNewline = true; + } + return *this; + } + + XmlWriter& writeComment( std::string const& text ) { + ensureTagClosed(); + stream() << m_indent << ""; + m_needsNewline = true; + return *this; + } + + XmlWriter& writeBlankLine() { + ensureTagClosed(); + stream() << "\n"; + return *this; + } + + void setStream( std::ostream& os ) { + m_os = &os; + } + + private: + XmlWriter( XmlWriter const& ); + void operator=( XmlWriter const& ); + + std::ostream& stream() { + return *m_os; + } + + void ensureTagClosed() { + if( m_tagIsOpen ) { + stream() << ">\n"; + m_tagIsOpen = false; + } + } + + void newlineIfNecessary() { + if( m_needsNewline ) { + stream() << "\n"; + m_needsNewline = false; + } + } + + bool m_tagIsOpen; + bool m_needsNewline; + std::vector m_tags; + std::string m_indent; + std::ostream* m_os; + }; + +} +// #included from: catch_reenable_warnings.h + +#define TWOBLUECUBES_CATCH_REENABLE_WARNINGS_H_INCLUDED + +#ifdef __clang__ +# ifdef __ICC // icpc defines the __clang__ macro +# pragma warning(pop) +# else +# pragma clang diagnostic pop +# endif +#elif defined __GNUC__ +# pragma GCC diagnostic pop +#endif + + +namespace Catch { + class XmlReporter : public StreamingReporterBase { + public: + XmlReporter( ReporterConfig const& _config ) + : StreamingReporterBase( _config ), + m_sectionDepth( 0 ) + { + m_reporterPrefs.shouldRedirectStdOut = true; + } + + virtual ~XmlReporter() CATCH_OVERRIDE; + + static std::string getDescription() { + return "Reports test results as an XML document"; + } + + public: // StreamingReporterBase + + virtual void noMatchingTestCases( std::string const& s ) CATCH_OVERRIDE { + StreamingReporterBase::noMatchingTestCases( s ); + } + + virtual void testRunStarting( TestRunInfo const& testInfo ) CATCH_OVERRIDE { + StreamingReporterBase::testRunStarting( testInfo ); + m_xml.setStream( stream ); + m_xml.startElement( "Catch" ); + if( !m_config->name().empty() ) + m_xml.writeAttribute( "name", m_config->name() ); + } + + virtual void testGroupStarting( GroupInfo const& groupInfo ) CATCH_OVERRIDE { + StreamingReporterBase::testGroupStarting( groupInfo ); + m_xml.startElement( "Group" ) + .writeAttribute( "name", groupInfo.name ); + } + + virtual void testCaseStarting( TestCaseInfo const& testInfo ) CATCH_OVERRIDE { + StreamingReporterBase::testCaseStarting(testInfo); + m_xml.startElement( "TestCase" ).writeAttribute( "name", trim( testInfo.name ) ); + + if ( m_config->showDurations() == ShowDurations::Always ) + m_testCaseTimer.start(); + } + + virtual void sectionStarting( SectionInfo const& sectionInfo ) CATCH_OVERRIDE { + StreamingReporterBase::sectionStarting( sectionInfo ); + if( m_sectionDepth++ > 0 ) { + m_xml.startElement( "Section" ) + .writeAttribute( "name", trim( sectionInfo.name ) ) + .writeAttribute( "description", sectionInfo.description ); + } + } + + virtual void assertionStarting( AssertionInfo const& ) CATCH_OVERRIDE { } + + virtual bool assertionEnded( AssertionStats const& assertionStats ) CATCH_OVERRIDE { + const AssertionResult& assertionResult = assertionStats.assertionResult; + + // Print any info messages in tags. + if( assertionStats.assertionResult.getResultType() != ResultWas::Ok ) { + for( std::vector::const_iterator it = assertionStats.infoMessages.begin(), itEnd = assertionStats.infoMessages.end(); + it != itEnd; + ++it ) { + if( it->type == ResultWas::Info ) { + m_xml.scopedElement( "Info" ) + .writeText( it->message ); + } else if ( it->type == ResultWas::Warning ) { + m_xml.scopedElement( "Warning" ) + .writeText( it->message ); + } + } + } + + // Drop out if result was successful but we're not printing them. + if( !m_config->includeSuccessfulResults() && isOk(assertionResult.getResultType()) ) + return true; + + // Print the expression if there is one. + if( assertionResult.hasExpression() ) { + m_xml.startElement( "Expression" ) + .writeAttribute( "success", assertionResult.succeeded() ) + .writeAttribute( "type", assertionResult.getTestMacroName() ) + .writeAttribute( "filename", assertionResult.getSourceInfo().file ) + .writeAttribute( "line", assertionResult.getSourceInfo().line ); + + m_xml.scopedElement( "Original" ) + .writeText( assertionResult.getExpression() ); + m_xml.scopedElement( "Expanded" ) + .writeText( assertionResult.getExpandedExpression() ); + } + + // And... Print a result applicable to each result type. + switch( assertionResult.getResultType() ) { + case ResultWas::ThrewException: + m_xml.scopedElement( "Exception" ) + .writeAttribute( "filename", assertionResult.getSourceInfo().file ) + .writeAttribute( "line", assertionResult.getSourceInfo().line ) + .writeText( assertionResult.getMessage() ); + break; + case ResultWas::FatalErrorCondition: + m_xml.scopedElement( "Fatal Error Condition" ) + .writeAttribute( "filename", assertionResult.getSourceInfo().file ) + .writeAttribute( "line", assertionResult.getSourceInfo().line ) + .writeText( assertionResult.getMessage() ); + break; + case ResultWas::Info: + m_xml.scopedElement( "Info" ) + .writeText( assertionResult.getMessage() ); + break; + case ResultWas::Warning: + // Warning will already have been written + break; + case ResultWas::ExplicitFailure: + m_xml.scopedElement( "Failure" ) + .writeText( assertionResult.getMessage() ); + break; + default: + break; + } + + if( assertionResult.hasExpression() ) + m_xml.endElement(); + + return true; + } + + virtual void sectionEnded( SectionStats const& sectionStats ) CATCH_OVERRIDE { + StreamingReporterBase::sectionEnded( sectionStats ); + if( --m_sectionDepth > 0 ) { + XmlWriter::ScopedElement e = m_xml.scopedElement( "OverallResults" ); + e.writeAttribute( "successes", sectionStats.assertions.passed ); + e.writeAttribute( "failures", sectionStats.assertions.failed ); + e.writeAttribute( "expectedFailures", sectionStats.assertions.failedButOk ); + + if ( m_config->showDurations() == ShowDurations::Always ) + e.writeAttribute( "durationInSeconds", sectionStats.durationInSeconds ); + + m_xml.endElement(); + } + } + + virtual void testCaseEnded( TestCaseStats const& testCaseStats ) CATCH_OVERRIDE { + StreamingReporterBase::testCaseEnded( testCaseStats ); + XmlWriter::ScopedElement e = m_xml.scopedElement( "OverallResult" ); + e.writeAttribute( "success", testCaseStats.totals.assertions.allOk() ); + + if ( m_config->showDurations() == ShowDurations::Always ) + e.writeAttribute( "durationInSeconds", m_testCaseTimer.getElapsedSeconds() ); + + m_xml.endElement(); + } + + virtual void testGroupEnded( TestGroupStats const& testGroupStats ) CATCH_OVERRIDE { + StreamingReporterBase::testGroupEnded( testGroupStats ); + // TODO: Check testGroupStats.aborting and act accordingly. + m_xml.scopedElement( "OverallResults" ) + .writeAttribute( "successes", testGroupStats.totals.assertions.passed ) + .writeAttribute( "failures", testGroupStats.totals.assertions.failed ) + .writeAttribute( "expectedFailures", testGroupStats.totals.assertions.failedButOk ); + m_xml.endElement(); + } + + virtual void testRunEnded( TestRunStats const& testRunStats ) CATCH_OVERRIDE { + StreamingReporterBase::testRunEnded( testRunStats ); + m_xml.scopedElement( "OverallResults" ) + .writeAttribute( "successes", testRunStats.totals.assertions.passed ) + .writeAttribute( "failures", testRunStats.totals.assertions.failed ) + .writeAttribute( "expectedFailures", testRunStats.totals.assertions.failedButOk ); + m_xml.endElement(); + } + + private: + Timer m_testCaseTimer; + XmlWriter m_xml; + int m_sectionDepth; + }; + + INTERNAL_CATCH_REGISTER_REPORTER( "xml", XmlReporter ) + +} // end namespace Catch + +// #included from: ../reporters/catch_reporter_junit.hpp +#define TWOBLUECUBES_CATCH_REPORTER_JUNIT_HPP_INCLUDED + +#include + +namespace Catch { + + class JunitReporter : public CumulativeReporterBase { + public: + JunitReporter( ReporterConfig const& _config ) + : CumulativeReporterBase( _config ), + xml( _config.stream() ) + { + m_reporterPrefs.shouldRedirectStdOut = true; + } + + virtual ~JunitReporter() CATCH_OVERRIDE; + + static std::string getDescription() { + return "Reports test results in an XML format that looks like Ant's junitreport target"; + } + + virtual void noMatchingTestCases( std::string const& /*spec*/ ) CATCH_OVERRIDE {} + + virtual void testRunStarting( TestRunInfo const& runInfo ) CATCH_OVERRIDE { + CumulativeReporterBase::testRunStarting( runInfo ); + xml.startElement( "testsuites" ); + } + + virtual void testGroupStarting( GroupInfo const& groupInfo ) CATCH_OVERRIDE { + suiteTimer.start(); + stdOutForSuite.str(""); + stdErrForSuite.str(""); + unexpectedExceptions = 0; + CumulativeReporterBase::testGroupStarting( groupInfo ); + } + + virtual bool assertionEnded( AssertionStats const& assertionStats ) CATCH_OVERRIDE { + if( assertionStats.assertionResult.getResultType() == ResultWas::ThrewException ) + unexpectedExceptions++; + return CumulativeReporterBase::assertionEnded( assertionStats ); + } + + virtual void testCaseEnded( TestCaseStats const& testCaseStats ) CATCH_OVERRIDE { + stdOutForSuite << testCaseStats.stdOut; + stdErrForSuite << testCaseStats.stdErr; + CumulativeReporterBase::testCaseEnded( testCaseStats ); + } + + virtual void testGroupEnded( TestGroupStats const& testGroupStats ) CATCH_OVERRIDE { + double suiteTime = suiteTimer.getElapsedSeconds(); + CumulativeReporterBase::testGroupEnded( testGroupStats ); + writeGroup( *m_testGroups.back(), suiteTime ); + } + + virtual void testRunEndedCumulative() CATCH_OVERRIDE { + xml.endElement(); + } + + void writeGroup( TestGroupNode const& groupNode, double suiteTime ) { + XmlWriter::ScopedElement e = xml.scopedElement( "testsuite" ); + TestGroupStats const& stats = groupNode.value; + xml.writeAttribute( "name", stats.groupInfo.name ); + xml.writeAttribute( "errors", unexpectedExceptions ); + xml.writeAttribute( "failures", stats.totals.assertions.failed-unexpectedExceptions ); + xml.writeAttribute( "tests", stats.totals.assertions.total() ); + xml.writeAttribute( "hostname", "tbd" ); // !TBD + if( m_config->showDurations() == ShowDurations::Never ) + xml.writeAttribute( "time", "" ); + else + xml.writeAttribute( "time", suiteTime ); + xml.writeAttribute( "timestamp", "tbd" ); // !TBD + + // Write test cases + for( TestGroupNode::ChildNodes::const_iterator + it = groupNode.children.begin(), itEnd = groupNode.children.end(); + it != itEnd; + ++it ) + writeTestCase( **it ); + + xml.scopedElement( "system-out" ).writeText( trim( stdOutForSuite.str() ), false ); + xml.scopedElement( "system-err" ).writeText( trim( stdErrForSuite.str() ), false ); + } + + void writeTestCase( TestCaseNode const& testCaseNode ) { + TestCaseStats const& stats = testCaseNode.value; + + // All test cases have exactly one section - which represents the + // test case itself. That section may have 0-n nested sections + assert( testCaseNode.children.size() == 1 ); + SectionNode const& rootSection = *testCaseNode.children.front(); + + std::string className = stats.testInfo.className; + + if( className.empty() ) { + if( rootSection.childSections.empty() ) + className = "global"; + } + writeSection( className, "", rootSection ); + } + + void writeSection( std::string const& className, + std::string const& rootName, + SectionNode const& sectionNode ) { + std::string name = trim( sectionNode.stats.sectionInfo.name ); + if( !rootName.empty() ) + name = rootName + "/" + name; + + if( !sectionNode.assertions.empty() || + !sectionNode.stdOut.empty() || + !sectionNode.stdErr.empty() ) { + XmlWriter::ScopedElement e = xml.scopedElement( "testcase" ); + if( className.empty() ) { + xml.writeAttribute( "classname", name ); + xml.writeAttribute( "name", "root" ); + } + else { + xml.writeAttribute( "classname", className ); + xml.writeAttribute( "name", name ); + } + xml.writeAttribute( "time", Catch::toString( sectionNode.stats.durationInSeconds ) ); + + writeAssertions( sectionNode ); + + if( !sectionNode.stdOut.empty() ) + xml.scopedElement( "system-out" ).writeText( trim( sectionNode.stdOut ), false ); + if( !sectionNode.stdErr.empty() ) + xml.scopedElement( "system-err" ).writeText( trim( sectionNode.stdErr ), false ); + } + for( SectionNode::ChildSections::const_iterator + it = sectionNode.childSections.begin(), + itEnd = sectionNode.childSections.end(); + it != itEnd; + ++it ) + if( className.empty() ) + writeSection( name, "", **it ); + else + writeSection( className, name, **it ); + } + + void writeAssertions( SectionNode const& sectionNode ) { + for( SectionNode::Assertions::const_iterator + it = sectionNode.assertions.begin(), itEnd = sectionNode.assertions.end(); + it != itEnd; + ++it ) + writeAssertion( *it ); + } + void writeAssertion( AssertionStats const& stats ) { + AssertionResult const& result = stats.assertionResult; + if( !result.isOk() ) { + std::string elementName; + switch( result.getResultType() ) { + case ResultWas::ThrewException: + case ResultWas::FatalErrorCondition: + elementName = "error"; + break; + case ResultWas::ExplicitFailure: + elementName = "failure"; + break; + case ResultWas::ExpressionFailed: + elementName = "failure"; + break; + case ResultWas::DidntThrowException: + elementName = "failure"; + break; + + // We should never see these here: + case ResultWas::Info: + case ResultWas::Warning: + case ResultWas::Ok: + case ResultWas::Unknown: + case ResultWas::FailureBit: + case ResultWas::Exception: + elementName = "internalError"; + break; + } + + XmlWriter::ScopedElement e = xml.scopedElement( elementName ); + + xml.writeAttribute( "message", result.getExpandedExpression() ); + xml.writeAttribute( "type", result.getTestMacroName() ); + + std::ostringstream oss; + if( !result.getMessage().empty() ) + oss << result.getMessage() << "\n"; + for( std::vector::const_iterator + it = stats.infoMessages.begin(), + itEnd = stats.infoMessages.end(); + it != itEnd; + ++it ) + if( it->type == ResultWas::Info ) + oss << it->message << "\n"; + + oss << "at " << result.getSourceInfo(); + xml.writeText( oss.str(), false ); + } + } + + XmlWriter xml; + Timer suiteTimer; + std::ostringstream stdOutForSuite; + std::ostringstream stdErrForSuite; + unsigned int unexpectedExceptions; + }; + + INTERNAL_CATCH_REGISTER_REPORTER( "junit", JunitReporter ) + +} // end namespace Catch + +// #included from: ../reporters/catch_reporter_console.hpp +#define TWOBLUECUBES_CATCH_REPORTER_CONSOLE_HPP_INCLUDED + +namespace Catch { + + struct ConsoleReporter : StreamingReporterBase { + ConsoleReporter( ReporterConfig const& _config ) + : StreamingReporterBase( _config ), + m_headerPrinted( false ) + {} + + virtual ~ConsoleReporter() CATCH_OVERRIDE; + static std::string getDescription() { + return "Reports test results as plain lines of text"; + } + + virtual void noMatchingTestCases( std::string const& spec ) CATCH_OVERRIDE { + stream << "No test cases matched '" << spec << "'" << std::endl; + } + + virtual void assertionStarting( AssertionInfo const& ) CATCH_OVERRIDE { + } + + virtual bool assertionEnded( AssertionStats const& _assertionStats ) CATCH_OVERRIDE { + AssertionResult const& result = _assertionStats.assertionResult; + + bool printInfoMessages = true; + + // Drop out if result was successful and we're not printing those + if( !m_config->includeSuccessfulResults() && result.isOk() ) { + if( result.getResultType() != ResultWas::Warning ) + return false; + printInfoMessages = false; + } + + lazyPrint(); + + AssertionPrinter printer( stream, _assertionStats, printInfoMessages ); + printer.print(); + stream << std::endl; + return true; + } + + virtual void sectionStarting( SectionInfo const& _sectionInfo ) CATCH_OVERRIDE { + m_headerPrinted = false; + StreamingReporterBase::sectionStarting( _sectionInfo ); + } + virtual void sectionEnded( SectionStats const& _sectionStats ) CATCH_OVERRIDE { + if( _sectionStats.missingAssertions ) { + lazyPrint(); + Colour colour( Colour::ResultError ); + if( m_sectionStack.size() > 1 ) + stream << "\nNo assertions in section"; + else + stream << "\nNo assertions in test case"; + stream << " '" << _sectionStats.sectionInfo.name << "'\n" << std::endl; + } + if( m_headerPrinted ) { + if( m_config->showDurations() == ShowDurations::Always ) + stream << "Completed in " << _sectionStats.durationInSeconds << "s" << std::endl; + m_headerPrinted = false; + } + else { + if( m_config->showDurations() == ShowDurations::Always ) + stream << _sectionStats.sectionInfo.name << " completed in " << _sectionStats.durationInSeconds << "s" << std::endl; + } + StreamingReporterBase::sectionEnded( _sectionStats ); + } + + virtual void testCaseEnded( TestCaseStats const& _testCaseStats ) CATCH_OVERRIDE { + StreamingReporterBase::testCaseEnded( _testCaseStats ); + m_headerPrinted = false; + } + virtual void testGroupEnded( TestGroupStats const& _testGroupStats ) CATCH_OVERRIDE { + if( currentGroupInfo.used ) { + printSummaryDivider(); + stream << "Summary for group '" << _testGroupStats.groupInfo.name << "':\n"; + printTotals( _testGroupStats.totals ); + stream << "\n" << std::endl; + } + StreamingReporterBase::testGroupEnded( _testGroupStats ); + } + virtual void testRunEnded( TestRunStats const& _testRunStats ) CATCH_OVERRIDE { + printTotalsDivider( _testRunStats.totals ); + printTotals( _testRunStats.totals ); + stream << std::endl; + StreamingReporterBase::testRunEnded( _testRunStats ); + } + + private: + + class AssertionPrinter { + void operator= ( AssertionPrinter const& ); + public: + AssertionPrinter( std::ostream& _stream, AssertionStats const& _stats, bool _printInfoMessages ) + : stream( _stream ), + stats( _stats ), + result( _stats.assertionResult ), + colour( Colour::None ), + message( result.getMessage() ), + messages( _stats.infoMessages ), + printInfoMessages( _printInfoMessages ) + { + switch( result.getResultType() ) { + case ResultWas::Ok: + colour = Colour::Success; + passOrFail = "PASSED"; + //if( result.hasMessage() ) + if( _stats.infoMessages.size() == 1 ) + messageLabel = "with message"; + if( _stats.infoMessages.size() > 1 ) + messageLabel = "with messages"; + break; + case ResultWas::ExpressionFailed: + if( result.isOk() ) { + colour = Colour::Success; + passOrFail = "FAILED - but was ok"; + } + else { + colour = Colour::Error; + passOrFail = "FAILED"; + } + if( _stats.infoMessages.size() == 1 ) + messageLabel = "with message"; + if( _stats.infoMessages.size() > 1 ) + messageLabel = "with messages"; + break; + case ResultWas::ThrewException: + colour = Colour::Error; + passOrFail = "FAILED"; + messageLabel = "due to unexpected exception with message"; + break; + case ResultWas::FatalErrorCondition: + colour = Colour::Error; + passOrFail = "FAILED"; + messageLabel = "due to a fatal error condition"; + break; + case ResultWas::DidntThrowException: + colour = Colour::Error; + passOrFail = "FAILED"; + messageLabel = "because no exception was thrown where one was expected"; + break; + case ResultWas::Info: + messageLabel = "info"; + break; + case ResultWas::Warning: + messageLabel = "warning"; + break; + case ResultWas::ExplicitFailure: + passOrFail = "FAILED"; + colour = Colour::Error; + if( _stats.infoMessages.size() == 1 ) + messageLabel = "explicitly with message"; + if( _stats.infoMessages.size() > 1 ) + messageLabel = "explicitly with messages"; + break; + // These cases are here to prevent compiler warnings + case ResultWas::Unknown: + case ResultWas::FailureBit: + case ResultWas::Exception: + passOrFail = "** internal error **"; + colour = Colour::Error; + break; + } + } + + void print() const { + printSourceInfo(); + if( stats.totals.assertions.total() > 0 ) { + if( result.isOk() ) + stream << "\n"; + printResultType(); + printOriginalExpression(); + printReconstructedExpression(); + } + else { + stream << "\n"; + } + printMessage(); + } + + private: + void printResultType() const { + if( !passOrFail.empty() ) { + Colour colourGuard( colour ); + stream << passOrFail << ":\n"; + } + } + void printOriginalExpression() const { + if( result.hasExpression() ) { + Colour colourGuard( Colour::OriginalExpression ); + stream << " "; + stream << result.getExpressionInMacro(); + stream << "\n"; + } + } + void printReconstructedExpression() const { + if( result.hasExpandedExpression() ) { + stream << "with expansion:\n"; + Colour colourGuard( Colour::ReconstructedExpression ); + stream << Text( result.getExpandedExpression(), TextAttributes().setIndent(2) ) << "\n"; + } + } + void printMessage() const { + if( !messageLabel.empty() ) + stream << messageLabel << ":" << "\n"; + for( std::vector::const_iterator it = messages.begin(), itEnd = messages.end(); + it != itEnd; + ++it ) { + // If this assertion is a warning ignore any INFO messages + if( printInfoMessages || it->type != ResultWas::Info ) + stream << Text( it->message, TextAttributes().setIndent(2) ) << "\n"; + } + } + void printSourceInfo() const { + Colour colourGuard( Colour::FileName ); + stream << result.getSourceInfo() << ": "; + } + + std::ostream& stream; + AssertionStats const& stats; + AssertionResult const& result; + Colour::Code colour; + std::string passOrFail; + std::string messageLabel; + std::string message; + std::vector messages; + bool printInfoMessages; + }; + + void lazyPrint() { + + if( !currentTestRunInfo.used ) + lazyPrintRunInfo(); + if( !currentGroupInfo.used ) + lazyPrintGroupInfo(); + + if( !m_headerPrinted ) { + printTestCaseAndSectionHeader(); + m_headerPrinted = true; + } + } + void lazyPrintRunInfo() { + stream << "\n" << getLineOfChars<'~'>() << "\n"; + Colour colour( Colour::SecondaryText ); + stream << currentTestRunInfo->name + << " is a Catch v" << libraryVersion << " host application.\n" + << "Run with -? for options\n\n"; + + if( m_config->rngSeed() != 0 ) + stream << "Randomness seeded to: " << m_config->rngSeed() << "\n\n"; + + currentTestRunInfo.used = true; + } + void lazyPrintGroupInfo() { + if( !currentGroupInfo->name.empty() && currentGroupInfo->groupsCounts > 1 ) { + printClosedHeader( "Group: " + currentGroupInfo->name ); + currentGroupInfo.used = true; + } + } + void printTestCaseAndSectionHeader() { + assert( !m_sectionStack.empty() ); + printOpenHeader( currentTestCaseInfo->name ); + + if( m_sectionStack.size() > 1 ) { + Colour colourGuard( Colour::Headers ); + + std::vector::const_iterator + it = m_sectionStack.begin()+1, // Skip first section (test case) + itEnd = m_sectionStack.end(); + for( ; it != itEnd; ++it ) + printHeaderString( it->name, 2 ); + } + + SourceLineInfo lineInfo = m_sectionStack.front().lineInfo; + + if( !lineInfo.empty() ){ + stream << getLineOfChars<'-'>() << "\n"; + Colour colourGuard( Colour::FileName ); + stream << lineInfo << "\n"; + } + stream << getLineOfChars<'.'>() << "\n" << std::endl; + } + + void printClosedHeader( std::string const& _name ) { + printOpenHeader( _name ); + stream << getLineOfChars<'.'>() << "\n"; + } + void printOpenHeader( std::string const& _name ) { + stream << getLineOfChars<'-'>() << "\n"; + { + Colour colourGuard( Colour::Headers ); + printHeaderString( _name ); + } + } + + // if string has a : in first line will set indent to follow it on + // subsequent lines + void printHeaderString( std::string const& _string, std::size_t indent = 0 ) { + std::size_t i = _string.find( ": " ); + if( i != std::string::npos ) + i+=2; + else + i = 0; + stream << Text( _string, TextAttributes() + .setIndent( indent+i) + .setInitialIndent( indent ) ) << "\n"; + } + + struct SummaryColumn { + + SummaryColumn( std::string const& _label, Colour::Code _colour ) + : label( _label ), + colour( _colour ) + {} + SummaryColumn addRow( std::size_t count ) { + std::ostringstream oss; + oss << count; + std::string row = oss.str(); + for( std::vector::iterator it = rows.begin(); it != rows.end(); ++it ) { + while( it->size() < row.size() ) + *it = " " + *it; + while( it->size() > row.size() ) + row = " " + row; + } + rows.push_back( row ); + return *this; + } + + std::string label; + Colour::Code colour; + std::vector rows; + + }; + + void printTotals( Totals const& totals ) { + if( totals.testCases.total() == 0 ) { + stream << Colour( Colour::Warning ) << "No tests ran\n"; + } + else if( totals.assertions.total() > 0 && totals.testCases.allPassed() ) { + stream << Colour( Colour::ResultSuccess ) << "All tests passed"; + stream << " (" + << pluralise( totals.assertions.passed, "assertion" ) << " in " + << pluralise( totals.testCases.passed, "test case" ) << ")" + << "\n"; + } + else { + + std::vector columns; + columns.push_back( SummaryColumn( "", Colour::None ) + .addRow( totals.testCases.total() ) + .addRow( totals.assertions.total() ) ); + columns.push_back( SummaryColumn( "passed", Colour::Success ) + .addRow( totals.testCases.passed ) + .addRow( totals.assertions.passed ) ); + columns.push_back( SummaryColumn( "failed", Colour::ResultError ) + .addRow( totals.testCases.failed ) + .addRow( totals.assertions.failed ) ); + columns.push_back( SummaryColumn( "failed as expected", Colour::ResultExpectedFailure ) + .addRow( totals.testCases.failedButOk ) + .addRow( totals.assertions.failedButOk ) ); + + printSummaryRow( "test cases", columns, 0 ); + printSummaryRow( "assertions", columns, 1 ); + } + } + void printSummaryRow( std::string const& label, std::vector const& cols, std::size_t row ) { + for( std::vector::const_iterator it = cols.begin(); it != cols.end(); ++it ) { + std::string value = it->rows[row]; + if( it->label.empty() ) { + stream << label << ": "; + if( value != "0" ) + stream << value; + else + stream << Colour( Colour::Warning ) << "- none -"; + } + else if( value != "0" ) { + stream << Colour( Colour::LightGrey ) << " | "; + stream << Colour( it->colour ) + << value << " " << it->label; + } + } + stream << "\n"; + } + + static std::size_t makeRatio( std::size_t number, std::size_t total ) { + std::size_t ratio = total > 0 ? CATCH_CONFIG_CONSOLE_WIDTH * number/ total : 0; + return ( ratio == 0 && number > 0 ) ? 1 : ratio; + } + static std::size_t& findMax( std::size_t& i, std::size_t& j, std::size_t& k ) { + if( i > j && i > k ) + return i; + else if( j > k ) + return j; + else + return k; + } + + void printTotalsDivider( Totals const& totals ) { + if( totals.testCases.total() > 0 ) { + std::size_t failedRatio = makeRatio( totals.testCases.failed, totals.testCases.total() ); + std::size_t failedButOkRatio = makeRatio( totals.testCases.failedButOk, totals.testCases.total() ); + std::size_t passedRatio = makeRatio( totals.testCases.passed, totals.testCases.total() ); + while( failedRatio + failedButOkRatio + passedRatio < CATCH_CONFIG_CONSOLE_WIDTH-1 ) + findMax( failedRatio, failedButOkRatio, passedRatio )++; + while( failedRatio + failedButOkRatio + passedRatio > CATCH_CONFIG_CONSOLE_WIDTH-1 ) + findMax( failedRatio, failedButOkRatio, passedRatio )--; + + stream << Colour( Colour::Error ) << std::string( failedRatio, '=' ); + stream << Colour( Colour::ResultExpectedFailure ) << std::string( failedButOkRatio, '=' ); + if( totals.testCases.allPassed() ) + stream << Colour( Colour::ResultSuccess ) << std::string( passedRatio, '=' ); + else + stream << Colour( Colour::Success ) << std::string( passedRatio, '=' ); + } + else { + stream << Colour( Colour::Warning ) << std::string( CATCH_CONFIG_CONSOLE_WIDTH-1, '=' ); + } + stream << "\n"; + } + void printSummaryDivider() { + stream << getLineOfChars<'-'>() << "\n"; + } + + private: + bool m_headerPrinted; + }; + + INTERNAL_CATCH_REGISTER_REPORTER( "console", ConsoleReporter ) + +} // end namespace Catch + +// #included from: ../reporters/catch_reporter_compact.hpp +#define TWOBLUECUBES_CATCH_REPORTER_COMPACT_HPP_INCLUDED + +namespace Catch { + + struct CompactReporter : StreamingReporterBase { + + CompactReporter( ReporterConfig const& _config ) + : StreamingReporterBase( _config ) + {} + + virtual ~CompactReporter(); + + static std::string getDescription() { + return "Reports test results on a single line, suitable for IDEs"; + } + + virtual ReporterPreferences getPreferences() const { + ReporterPreferences prefs; + prefs.shouldRedirectStdOut = false; + return prefs; + } + + virtual void noMatchingTestCases( std::string const& spec ) { + stream << "No test cases matched '" << spec << "'" << std::endl; + } + + virtual void assertionStarting( AssertionInfo const& ) { + } + + virtual bool assertionEnded( AssertionStats const& _assertionStats ) { + AssertionResult const& result = _assertionStats.assertionResult; + + bool printInfoMessages = true; + + // Drop out if result was successful and we're not printing those + if( !m_config->includeSuccessfulResults() && result.isOk() ) { + if( result.getResultType() != ResultWas::Warning ) + return false; + printInfoMessages = false; + } + + AssertionPrinter printer( stream, _assertionStats, printInfoMessages ); + printer.print(); + + stream << std::endl; + return true; + } + + virtual void testRunEnded( TestRunStats const& _testRunStats ) { + printTotals( _testRunStats.totals ); + stream << "\n" << std::endl; + StreamingReporterBase::testRunEnded( _testRunStats ); + } + + private: + class AssertionPrinter { + void operator= ( AssertionPrinter const& ); + public: + AssertionPrinter( std::ostream& _stream, AssertionStats const& _stats, bool _printInfoMessages ) + : stream( _stream ) + , stats( _stats ) + , result( _stats.assertionResult ) + , messages( _stats.infoMessages ) + , itMessage( _stats.infoMessages.begin() ) + , printInfoMessages( _printInfoMessages ) + {} + + void print() { + printSourceInfo(); + + itMessage = messages.begin(); + + switch( result.getResultType() ) { + case ResultWas::Ok: + printResultType( Colour::ResultSuccess, passedString() ); + printOriginalExpression(); + printReconstructedExpression(); + if ( ! result.hasExpression() ) + printRemainingMessages( Colour::None ); + else + printRemainingMessages(); + break; + case ResultWas::ExpressionFailed: + if( result.isOk() ) + printResultType( Colour::ResultSuccess, failedString() + std::string( " - but was ok" ) ); + else + printResultType( Colour::Error, failedString() ); + printOriginalExpression(); + printReconstructedExpression(); + printRemainingMessages(); + break; + case ResultWas::ThrewException: + printResultType( Colour::Error, failedString() ); + printIssue( "unexpected exception with message:" ); + printMessage(); + printExpressionWas(); + printRemainingMessages(); + break; + case ResultWas::FatalErrorCondition: + printResultType( Colour::Error, failedString() ); + printIssue( "fatal error condition with message:" ); + printMessage(); + printExpressionWas(); + printRemainingMessages(); + break; + case ResultWas::DidntThrowException: + printResultType( Colour::Error, failedString() ); + printIssue( "expected exception, got none" ); + printExpressionWas(); + printRemainingMessages(); + break; + case ResultWas::Info: + printResultType( Colour::None, "info" ); + printMessage(); + printRemainingMessages(); + break; + case ResultWas::Warning: + printResultType( Colour::None, "warning" ); + printMessage(); + printRemainingMessages(); + break; + case ResultWas::ExplicitFailure: + printResultType( Colour::Error, failedString() ); + printIssue( "explicitly" ); + printRemainingMessages( Colour::None ); + break; + // These cases are here to prevent compiler warnings + case ResultWas::Unknown: + case ResultWas::FailureBit: + case ResultWas::Exception: + printResultType( Colour::Error, "** internal error **" ); + break; + } + } + + private: + // Colour::LightGrey + + static Colour::Code dimColour() { return Colour::FileName; } + +#ifdef CATCH_PLATFORM_MAC + static const char* failedString() { return "FAILED"; } + static const char* passedString() { return "PASSED"; } +#else + static const char* failedString() { return "failed"; } + static const char* passedString() { return "passed"; } +#endif + + void printSourceInfo() const { + Colour colourGuard( Colour::FileName ); + stream << result.getSourceInfo() << ":"; + } + + void printResultType( Colour::Code colour, std::string passOrFail ) const { + if( !passOrFail.empty() ) { + { + Colour colourGuard( colour ); + stream << " " << passOrFail; + } + stream << ":"; + } + } + + void printIssue( std::string issue ) const { + stream << " " << issue; + } + + void printExpressionWas() { + if( result.hasExpression() ) { + stream << ";"; + { + Colour colour( dimColour() ); + stream << " expression was:"; + } + printOriginalExpression(); + } + } + + void printOriginalExpression() const { + if( result.hasExpression() ) { + stream << " " << result.getExpression(); + } + } + + void printReconstructedExpression() const { + if( result.hasExpandedExpression() ) { + { + Colour colour( dimColour() ); + stream << " for: "; + } + stream << result.getExpandedExpression(); + } + } + + void printMessage() { + if ( itMessage != messages.end() ) { + stream << " '" << itMessage->message << "'"; + ++itMessage; + } + } + + void printRemainingMessages( Colour::Code colour = dimColour() ) { + if ( itMessage == messages.end() ) + return; + + // using messages.end() directly yields compilation error: + std::vector::const_iterator itEnd = messages.end(); + const std::size_t N = static_cast( std::distance( itMessage, itEnd ) ); + + { + Colour colourGuard( colour ); + stream << " with " << pluralise( N, "message" ) << ":"; + } + + for(; itMessage != itEnd; ) { + // If this assertion is a warning ignore any INFO messages + if( printInfoMessages || itMessage->type != ResultWas::Info ) { + stream << " '" << itMessage->message << "'"; + if ( ++itMessage != itEnd ) { + Colour colourGuard( dimColour() ); + stream << " and"; + } + } + } + } + + private: + std::ostream& stream; + AssertionStats const& stats; + AssertionResult const& result; + std::vector messages; + std::vector::const_iterator itMessage; + bool printInfoMessages; + }; + + // Colour, message variants: + // - white: No tests ran. + // - red: Failed [both/all] N test cases, failed [both/all] M assertions. + // - white: Passed [both/all] N test cases (no assertions). + // - red: Failed N tests cases, failed M assertions. + // - green: Passed [both/all] N tests cases with M assertions. + + std::string bothOrAll( std::size_t count ) const { + return count == 1 ? "" : count == 2 ? "both " : "all " ; + } + + void printTotals( const Totals& totals ) const { + if( totals.testCases.total() == 0 ) { + stream << "No tests ran."; + } + else if( totals.testCases.failed == totals.testCases.total() ) { + Colour colour( Colour::ResultError ); + const std::string qualify_assertions_failed = + totals.assertions.failed == totals.assertions.total() ? + bothOrAll( totals.assertions.failed ) : ""; + stream << + "Failed " << bothOrAll( totals.testCases.failed ) + << pluralise( totals.testCases.failed, "test case" ) << ", " + "failed " << qualify_assertions_failed << + pluralise( totals.assertions.failed, "assertion" ) << "."; + } + else if( totals.assertions.total() == 0 ) { + stream << + "Passed " << bothOrAll( totals.testCases.total() ) + << pluralise( totals.testCases.total(), "test case" ) + << " (no assertions)."; + } + else if( totals.assertions.failed ) { + Colour colour( Colour::ResultError ); + stream << + "Failed " << pluralise( totals.testCases.failed, "test case" ) << ", " + "failed " << pluralise( totals.assertions.failed, "assertion" ) << "."; + } + else { + Colour colour( Colour::ResultSuccess ); + stream << + "Passed " << bothOrAll( totals.testCases.passed ) + << pluralise( totals.testCases.passed, "test case" ) << + " with " << pluralise( totals.assertions.passed, "assertion" ) << "."; + } + } + }; + + INTERNAL_CATCH_REGISTER_REPORTER( "compact", CompactReporter ) + +} // end namespace Catch + +namespace Catch { + // These are all here to avoid warnings about not having any out of line + // virtual methods + NonCopyable::~NonCopyable() {} + IShared::~IShared() {} + IStream::~IStream() CATCH_NOEXCEPT {} + FileStream::~FileStream() CATCH_NOEXCEPT {} + CoutStream::~CoutStream() CATCH_NOEXCEPT {} + DebugOutStream::~DebugOutStream() CATCH_NOEXCEPT {} + StreamBufBase::~StreamBufBase() CATCH_NOEXCEPT {} + IContext::~IContext() {} + IResultCapture::~IResultCapture() {} + ITestCase::~ITestCase() {} + ITestCaseRegistry::~ITestCaseRegistry() {} + IRegistryHub::~IRegistryHub() {} + IMutableRegistryHub::~IMutableRegistryHub() {} + IExceptionTranslator::~IExceptionTranslator() {} + IExceptionTranslatorRegistry::~IExceptionTranslatorRegistry() {} + IReporter::~IReporter() {} + IReporterFactory::~IReporterFactory() {} + IReporterRegistry::~IReporterRegistry() {} + IStreamingReporter::~IStreamingReporter() {} + AssertionStats::~AssertionStats() {} + SectionStats::~SectionStats() {} + TestCaseStats::~TestCaseStats() {} + TestGroupStats::~TestGroupStats() {} + TestRunStats::~TestRunStats() {} + CumulativeReporterBase::SectionNode::~SectionNode() {} + CumulativeReporterBase::~CumulativeReporterBase() {} + + StreamingReporterBase::~StreamingReporterBase() {} + ConsoleReporter::~ConsoleReporter() {} + CompactReporter::~CompactReporter() {} + IRunner::~IRunner() {} + IMutableContext::~IMutableContext() {} + IConfig::~IConfig() {} + XmlReporter::~XmlReporter() {} + JunitReporter::~JunitReporter() {} + TestRegistry::~TestRegistry() {} + FreeFunctionTestCase::~FreeFunctionTestCase() {} + IGeneratorInfo::~IGeneratorInfo() {} + IGeneratorsForTest::~IGeneratorsForTest() {} + WildcardPattern::~WildcardPattern() {} + TestSpec::Pattern::~Pattern() {} + TestSpec::NamePattern::~NamePattern() {} + TestSpec::TagPattern::~TagPattern() {} + TestSpec::ExcludedPattern::~ExcludedPattern() {} + + Matchers::Impl::StdString::Equals::~Equals() {} + Matchers::Impl::StdString::Contains::~Contains() {} + Matchers::Impl::StdString::StartsWith::~StartsWith() {} + Matchers::Impl::StdString::EndsWith::~EndsWith() {} + + void Config::dummy() {} + + namespace TestCaseTracking { + ITracker::~ITracker() {} + TrackerBase::~TrackerBase() {} + SectionTracker::~SectionTracker() {} + IndexTracker::~IndexTracker() {} + } +} + +#ifdef __clang__ +#pragma clang diagnostic pop +#endif + +#endif + +#ifdef CATCH_CONFIG_MAIN +// #included from: internal/catch_default_main.hpp +#define TWOBLUECUBES_CATCH_DEFAULT_MAIN_HPP_INCLUDED + +#ifndef __OBJC__ + +// Standard C/C++ main entry point +int main (int argc, char * argv[]) { + return Catch::Session().run( argc, argv ); +} + +#else // __OBJC__ + +// Objective-C entry point +int main (int argc, char * const argv[]) { +#if !CATCH_ARC_ENABLED + NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init]; +#endif + + Catch::registerTestMethods(); + int result = Catch::Session().run( argc, (char* const*)argv ); + +#if !CATCH_ARC_ENABLED + [pool drain]; +#endif + + return result; +} + +#endif // __OBJC__ + +#endif + +#ifdef CLARA_CONFIG_MAIN_NOT_DEFINED +# undef CLARA_CONFIG_MAIN +#endif + +////// + +// If this config identifier is defined then all CATCH macros are prefixed with CATCH_ +#ifdef CATCH_CONFIG_PREFIX_ALL + +#define CATCH_REQUIRE( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::Normal, "CATCH_REQUIRE" ) +#define CATCH_REQUIRE_FALSE( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::Normal | Catch::ResultDisposition::FalseTest, "CATCH_REQUIRE_FALSE" ) + +#define CATCH_REQUIRE_THROWS( expr ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::Normal, "", "CATCH_REQUIRE_THROWS" ) +#define CATCH_REQUIRE_THROWS_AS( expr, exceptionType ) INTERNAL_CATCH_THROWS_AS( expr, exceptionType, Catch::ResultDisposition::Normal, "CATCH_REQUIRE_THROWS_AS" ) +#define CATCH_REQUIRE_THROWS_WITH( expr, matcher ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::Normal, matcher, "CATCH_REQUIRE_THROWS_WITH" ) +#define CATCH_REQUIRE_NOTHROW( expr ) INTERNAL_CATCH_NO_THROW( expr, Catch::ResultDisposition::Normal, "CATCH_REQUIRE_NOTHROW" ) + +#define CATCH_CHECK( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::ContinueOnFailure, "CATCH_CHECK" ) +#define CATCH_CHECK_FALSE( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::ContinueOnFailure | Catch::ResultDisposition::FalseTest, "CATCH_CHECK_FALSE" ) +#define CATCH_CHECKED_IF( expr ) INTERNAL_CATCH_IF( expr, Catch::ResultDisposition::ContinueOnFailure, "CATCH_CHECKED_IF" ) +#define CATCH_CHECKED_ELSE( expr ) INTERNAL_CATCH_ELSE( expr, Catch::ResultDisposition::ContinueOnFailure, "CATCH_CHECKED_ELSE" ) +#define CATCH_CHECK_NOFAIL( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::ContinueOnFailure | Catch::ResultDisposition::SuppressFail, "CATCH_CHECK_NOFAIL" ) + +#define CATCH_CHECK_THROWS( expr ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::ContinueOnFailure, "CATCH_CHECK_THROWS" ) +#define CATCH_CHECK_THROWS_AS( expr, exceptionType ) INTERNAL_CATCH_THROWS_AS( expr, exceptionType, Catch::ResultDisposition::ContinueOnFailure, "CATCH_CHECK_THROWS_AS" ) +#define CATCH_CHECK_THROWS_WITH( expr, matcher ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::ContinueOnFailure, matcher, "CATCH_CHECK_THROWS_WITH" ) +#define CATCH_CHECK_NOTHROW( expr ) INTERNAL_CATCH_NO_THROW( expr, Catch::ResultDisposition::ContinueOnFailure, "CATCH_CHECK_NOTHROW" ) + +#define CHECK_THAT( arg, matcher ) INTERNAL_CHECK_THAT( arg, matcher, Catch::ResultDisposition::ContinueOnFailure, "CATCH_CHECK_THAT" ) +#define CATCH_REQUIRE_THAT( arg, matcher ) INTERNAL_CHECK_THAT( arg, matcher, Catch::ResultDisposition::Normal, "CATCH_REQUIRE_THAT" ) + +#define CATCH_INFO( msg ) INTERNAL_CATCH_INFO( msg, "CATCH_INFO" ) +#define CATCH_WARN( msg ) INTERNAL_CATCH_MSG( Catch::ResultWas::Warning, Catch::ResultDisposition::ContinueOnFailure, "CATCH_WARN", msg ) +#define CATCH_SCOPED_INFO( msg ) INTERNAL_CATCH_INFO( msg, "CATCH_INFO" ) +#define CATCH_CAPTURE( msg ) INTERNAL_CATCH_INFO( #msg " := " << msg, "CATCH_CAPTURE" ) +#define CATCH_SCOPED_CAPTURE( msg ) INTERNAL_CATCH_INFO( #msg " := " << msg, "CATCH_CAPTURE" ) + +#ifdef CATCH_CONFIG_VARIADIC_MACROS + #define CATCH_TEST_CASE( ... ) INTERNAL_CATCH_TESTCASE( __VA_ARGS__ ) + #define CATCH_TEST_CASE_METHOD( className, ... ) INTERNAL_CATCH_TEST_CASE_METHOD( className, __VA_ARGS__ ) + #define CATCH_METHOD_AS_TEST_CASE( method, ... ) INTERNAL_CATCH_METHOD_AS_TEST_CASE( method, __VA_ARGS__ ) + #define CATCH_REGISTER_TEST_CASE( Function, ... ) INTERNAL_CATCH_REGISTER_TESTCASE( Function, __VA_ARGS__ ) + #define CATCH_SECTION( ... ) INTERNAL_CATCH_SECTION( __VA_ARGS__ ) + #define CATCH_FAIL( ... ) INTERNAL_CATCH_MSG( Catch::ResultWas::ExplicitFailure, Catch::ResultDisposition::Normal, "CATCH_FAIL", __VA_ARGS__ ) + #define CATCH_SUCCEED( ... ) INTERNAL_CATCH_MSG( Catch::ResultWas::Ok, Catch::ResultDisposition::ContinueOnFailure, "CATCH_SUCCEED", __VA_ARGS__ ) +#else + #define CATCH_TEST_CASE( name, description ) INTERNAL_CATCH_TESTCASE( name, description ) + #define CATCH_TEST_CASE_METHOD( className, name, description ) INTERNAL_CATCH_TEST_CASE_METHOD( className, name, description ) + #define CATCH_METHOD_AS_TEST_CASE( method, name, description ) INTERNAL_CATCH_METHOD_AS_TEST_CASE( method, name, description ) + #define CATCH_REGISTER_TEST_CASE( function, name, description ) INTERNAL_CATCH_REGISTER_TESTCASE( function, name, description ) + #define CATCH_SECTION( name, description ) INTERNAL_CATCH_SECTION( name, description ) + #define CATCH_FAIL( msg ) INTERNAL_CATCH_MSG( Catch::ResultWas::ExplicitFailure, Catch::ResultDisposition::Normal, "CATCH_FAIL", msg ) + #define CATCH_SUCCEED( msg ) INTERNAL_CATCH_MSG( Catch::ResultWas::Ok, Catch::ResultDisposition::ContinueOnFailure, "CATCH_SUCCEED", msg ) +#endif +#define CATCH_ANON_TEST_CASE() INTERNAL_CATCH_TESTCASE( "", "" ) + +#define CATCH_REGISTER_REPORTER( name, reporterType ) INTERNAL_CATCH_REGISTER_REPORTER( name, reporterType ) +#define CATCH_REGISTER_LEGACY_REPORTER( name, reporterType ) INTERNAL_CATCH_REGISTER_LEGACY_REPORTER( name, reporterType ) + +#define CATCH_GENERATE( expr) INTERNAL_CATCH_GENERATE( expr ) + +// "BDD-style" convenience wrappers +#ifdef CATCH_CONFIG_VARIADIC_MACROS +#define CATCH_SCENARIO( ... ) CATCH_TEST_CASE( "Scenario: " __VA_ARGS__ ) +#define CATCH_SCENARIO_METHOD( className, ... ) INTERNAL_CATCH_TEST_CASE_METHOD( className, "Scenario: " __VA_ARGS__ ) +#else +#define CATCH_SCENARIO( name, tags ) CATCH_TEST_CASE( "Scenario: " name, tags ) +#define CATCH_SCENARIO_METHOD( className, name, tags ) INTERNAL_CATCH_TEST_CASE_METHOD( className, "Scenario: " name, tags ) +#endif +#define CATCH_GIVEN( desc ) CATCH_SECTION( std::string( "Given: ") + desc, "" ) +#define CATCH_WHEN( desc ) CATCH_SECTION( std::string( " When: ") + desc, "" ) +#define CATCH_AND_WHEN( desc ) CATCH_SECTION( std::string( " And: ") + desc, "" ) +#define CATCH_THEN( desc ) CATCH_SECTION( std::string( " Then: ") + desc, "" ) +#define CATCH_AND_THEN( desc ) CATCH_SECTION( std::string( " And: ") + desc, "" ) + +// If CATCH_CONFIG_PREFIX_ALL is not defined then the CATCH_ prefix is not required +#else + +#define REQUIRE( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::Normal, "REQUIRE" ) +#define REQUIRE_FALSE( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::Normal | Catch::ResultDisposition::FalseTest, "REQUIRE_FALSE" ) + +#define REQUIRE_THROWS( expr ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::Normal, "", "REQUIRE_THROWS" ) +#define REQUIRE_THROWS_AS( expr, exceptionType ) INTERNAL_CATCH_THROWS_AS( expr, exceptionType, Catch::ResultDisposition::Normal, "REQUIRE_THROWS_AS" ) +#define REQUIRE_THROWS_WITH( expr, matcher ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::Normal, matcher, "REQUIRE_THROWS_WITH" ) +#define REQUIRE_NOTHROW( expr ) INTERNAL_CATCH_NO_THROW( expr, Catch::ResultDisposition::Normal, "REQUIRE_NOTHROW" ) + +#define CHECK( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::ContinueOnFailure, "CHECK" ) +#define CHECK_FALSE( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::ContinueOnFailure | Catch::ResultDisposition::FalseTest, "CHECK_FALSE" ) +#define CHECKED_IF( expr ) INTERNAL_CATCH_IF( expr, Catch::ResultDisposition::ContinueOnFailure, "CHECKED_IF" ) +#define CHECKED_ELSE( expr ) INTERNAL_CATCH_ELSE( expr, Catch::ResultDisposition::ContinueOnFailure, "CHECKED_ELSE" ) +#define CHECK_NOFAIL( expr ) INTERNAL_CATCH_TEST( expr, Catch::ResultDisposition::ContinueOnFailure | Catch::ResultDisposition::SuppressFail, "CHECK_NOFAIL" ) + +#define CHECK_THROWS( expr ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::ContinueOnFailure, "", "CHECK_THROWS" ) +#define CHECK_THROWS_AS( expr, exceptionType ) INTERNAL_CATCH_THROWS_AS( expr, exceptionType, Catch::ResultDisposition::ContinueOnFailure, "CHECK_THROWS_AS" ) +#define CHECK_THROWS_WITH( expr, matcher ) INTERNAL_CATCH_THROWS( expr, Catch::ResultDisposition::ContinueOnFailure, matcher, "CHECK_THROWS_WITH" ) +#define CHECK_NOTHROW( expr ) INTERNAL_CATCH_NO_THROW( expr, Catch::ResultDisposition::ContinueOnFailure, "CHECK_NOTHROW" ) + +#define CHECK_THAT( arg, matcher ) INTERNAL_CHECK_THAT( arg, matcher, Catch::ResultDisposition::ContinueOnFailure, "CHECK_THAT" ) +#define REQUIRE_THAT( arg, matcher ) INTERNAL_CHECK_THAT( arg, matcher, Catch::ResultDisposition::Normal, "REQUIRE_THAT" ) + +#define INFO( msg ) INTERNAL_CATCH_INFO( msg, "INFO" ) +#define WARN( msg ) INTERNAL_CATCH_MSG( Catch::ResultWas::Warning, Catch::ResultDisposition::ContinueOnFailure, "WARN", msg ) +#define SCOPED_INFO( msg ) INTERNAL_CATCH_INFO( msg, "INFO" ) +#define CAPTURE( msg ) INTERNAL_CATCH_INFO( #msg " := " << msg, "CAPTURE" ) +#define SCOPED_CAPTURE( msg ) INTERNAL_CATCH_INFO( #msg " := " << msg, "CAPTURE" ) + +#ifdef CATCH_CONFIG_VARIADIC_MACROS + #define TEST_CASE( ... ) INTERNAL_CATCH_TESTCASE( __VA_ARGS__ ) + #define TEST_CASE_METHOD( className, ... ) INTERNAL_CATCH_TEST_CASE_METHOD( className, __VA_ARGS__ ) + #define METHOD_AS_TEST_CASE( method, ... ) INTERNAL_CATCH_METHOD_AS_TEST_CASE( method, __VA_ARGS__ ) + #define REGISTER_TEST_CASE( Function, ... ) INTERNAL_CATCH_REGISTER_TESTCASE( Function, __VA_ARGS__ ) + #define SECTION( ... ) INTERNAL_CATCH_SECTION( __VA_ARGS__ ) + #define FAIL( ... ) INTERNAL_CATCH_MSG( Catch::ResultWas::ExplicitFailure, Catch::ResultDisposition::Normal, "FAIL", __VA_ARGS__ ) + #define SUCCEED( ... ) INTERNAL_CATCH_MSG( Catch::ResultWas::Ok, Catch::ResultDisposition::ContinueOnFailure, "SUCCEED", __VA_ARGS__ ) +#else + #define TEST_CASE( name, description ) INTERNAL_CATCH_TESTCASE( name, description ) + #define TEST_CASE_METHOD( className, name, description ) INTERNAL_CATCH_TEST_CASE_METHOD( className, name, description ) + #define METHOD_AS_TEST_CASE( method, name, description ) INTERNAL_CATCH_METHOD_AS_TEST_CASE( method, name, description ) + #define REGISTER_TEST_CASE( method, name, description ) INTERNAL_CATCH_REGISTER_TESTCASE( method, name, description ) + #define SECTION( name, description ) INTERNAL_CATCH_SECTION( name, description ) + #define FAIL( msg ) INTERNAL_CATCH_MSG( Catch::ResultWas::ExplicitFailure, Catch::ResultDisposition::Normal, "FAIL", msg ) + #define SUCCEED( msg ) INTERNAL_CATCH_MSG( Catch::ResultWas::Ok, Catch::ResultDisposition::ContinueOnFailure, "SUCCEED", msg ) +#endif +#define ANON_TEST_CASE() INTERNAL_CATCH_TESTCASE( "", "" ) + +#define REGISTER_REPORTER( name, reporterType ) INTERNAL_CATCH_REGISTER_REPORTER( name, reporterType ) +#define REGISTER_LEGACY_REPORTER( name, reporterType ) INTERNAL_CATCH_REGISTER_LEGACY_REPORTER( name, reporterType ) + +#define GENERATE( expr) INTERNAL_CATCH_GENERATE( expr ) + +#endif + +#define CATCH_TRANSLATE_EXCEPTION( signature ) INTERNAL_CATCH_TRANSLATE_EXCEPTION( signature ) + +// "BDD-style" convenience wrappers +#ifdef CATCH_CONFIG_VARIADIC_MACROS +#define SCENARIO( ... ) TEST_CASE( "Scenario: " __VA_ARGS__ ) +#define SCENARIO_METHOD( className, ... ) INTERNAL_CATCH_TEST_CASE_METHOD( className, "Scenario: " __VA_ARGS__ ) +#else +#define SCENARIO( name, tags ) TEST_CASE( "Scenario: " name, tags ) +#define SCENARIO_METHOD( className, name, tags ) INTERNAL_CATCH_TEST_CASE_METHOD( className, "Scenario: " name, tags ) +#endif +#define GIVEN( desc ) SECTION( std::string(" Given: ") + desc, "" ) +#define WHEN( desc ) SECTION( std::string(" When: ") + desc, "" ) +#define AND_WHEN( desc ) SECTION( std::string("And when: ") + desc, "" ) +#define THEN( desc ) SECTION( std::string(" Then: ") + desc, "" ) +#define AND_THEN( desc ) SECTION( std::string(" And: ") + desc, "" ) + +using Catch::Detail::Approx; + +#endif // TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED + diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index de4fe716a..1e1245160 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -5,6 +5,7 @@ add_subdirectory(common) add_subdirectory(core) add_subdirectory(video_core) add_subdirectory(audio_core) +add_subdirectory(tests) if (ENABLE_SDL2) add_subdirectory(citra) endif() diff --git a/src/common/CMakeLists.txt b/src/common/CMakeLists.txt index c839ce173..014748125 100644 --- a/src/common/CMakeLists.txt +++ b/src/common/CMakeLists.txt @@ -26,6 +26,7 @@ set(HEADERS assert.h bit_field.h bit_set.h + bit_util.h break_points.h chunk_file.h code_block.h diff --git a/src/common/bit_util.h b/src/common/bit_util.h new file mode 100644 index 000000000..a5f9b12b8 --- /dev/null +++ b/src/common/bit_util.h @@ -0,0 +1,47 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include + +namespace BitUtil { + +/// The size of a type in terms of bits +template +constexpr size_t BitSize() { + return sizeof(T) * CHAR_BIT; +} + +/// Extract bits [begin_bit, end_bit] inclusive from value of type T. +template +constexpr T Bits(const T value) { + static_assert(begin_bit < end_bit, "invalid bit range (position of beginning bit cannot be greater than that of end bit)"); + static_assert(begin_bit < BitSize(), "begin_bit must be smaller than size of T"); + static_assert(end_bit < BitSize(), "begin_bit must be smaller than size of T"); + + return (value >> begin_bit) & ((1 << (end_bit - begin_bit + 1)) - 1); +} + +/// Extracts a single bit at bit_position from value of type T. +template +constexpr T Bit(const T value) { + static_assert(bit_position < BitSize(), "bit_position must be smaller than size of T"); + + return (value >> bit_position) & 1; +} + +/// Sign-extends a value that has NBits bits to the full bitwidth of type T. +template +inline T SignExtend(const T value) { + static_assert(NBits <= BitSize(), "NBits larger than bitsize of T"); + + constexpr T mask = static_cast(1ULL << NBits) - 1; + const T signbit = Bit(value); + if (signbit != 0) { + return value | ~mask; + } + return value; +} + +} // namespace BitUtil diff --git a/src/common/common_funcs.h b/src/common/common_funcs.h index aa6aff7b9..8456809e4 100644 --- a/src/common/common_funcs.h +++ b/src/common/common_funcs.h @@ -68,18 +68,22 @@ inline u64 _rotr64(u64 x, unsigned int shift){ } #else // _MSC_VER - #if (_MSC_VER < 1900) - // Function Cross-Compatibility - #define snprintf _snprintf - #endif +#if (_MSC_VER < 1900) + // Function Cross-Compatibility + #define snprintf _snprintf +#endif - // Locale Cross-Compatibility - #define locale_t _locale_t +// Locale Cross-Compatibility +#define locale_t _locale_t + +extern "C" { + __declspec(dllimport) void __stdcall DebugBreak(void); +} +#define Crash() {DebugBreak();} + +#define rotr _rotr +#define rotl _rotl - extern "C" { - __declspec(dllimport) void __stdcall DebugBreak(void); - } - #define Crash() {DebugBreak();} #endif // _MSC_VER ndef // Generic function to get last error message. diff --git a/src/common/math_util.h b/src/common/math_util.h index d44b06e74..fc96d3641 100644 --- a/src/common/math_util.h +++ b/src/common/math_util.h @@ -5,6 +5,7 @@ #pragma once #include +#include #include #include @@ -16,14 +17,12 @@ inline bool IntervalsIntersect(unsigned start0, unsigned length0, unsigned start } template -inline T Clamp(const T val, const T& min, const T& max) -{ +inline T Clamp(const T val, const T& min, const T& max) { return std::max(min, std::min(max, val)); } template -struct Rectangle -{ +struct Rectangle { T left; T top; T right; diff --git a/src/common/x64/abi.h b/src/common/x64/abi.h index de6d62fdd..d8dba0ee6 100644 --- a/src/common/x64/abi.h +++ b/src/common/x64/abi.h @@ -29,31 +29,31 @@ #ifdef _WIN32 // 64-bit Windows - the really exotic calling convention -#define ABI_PARAM1 RCX -#define ABI_PARAM2 RDX -#define ABI_PARAM3 R8 -#define ABI_PARAM4 R9 +#define ABI_PARAM1 ::Gen::RCX +#define ABI_PARAM2 ::Gen::RDX +#define ABI_PARAM3 ::Gen::R8 +#define ABI_PARAM4 ::Gen::R9 // xmm0-xmm15 use the upper 16 bits in the functions that push/pop registers. #define ABI_ALL_CALLER_SAVED \ - (BitSet32 { RAX, RCX, RDX, R8, R9, R10, R11, \ - XMM0+16, XMM1+16, XMM2+16, XMM3+16, XMM4+16, XMM5+16 }) + (BitSet32 { ::Gen::RAX, ::Gen::RCX, ::Gen::RDX, ::Gen::R8, ::Gen::R9, ::Gen::R10, ::Gen::R11, \ + ::Gen::XMM0+16, ::Gen::XMM1+16, ::Gen::XMM2+16, ::Gen::XMM3+16, ::Gen::XMM4+16, ::Gen::XMM5+16 }) #else //64-bit Unix / OS X -#define ABI_PARAM1 RDI -#define ABI_PARAM2 RSI -#define ABI_PARAM3 RDX -#define ABI_PARAM4 RCX -#define ABI_PARAM5 R8 -#define ABI_PARAM6 R9 +#define ABI_PARAM1 ::Gen::RDI +#define ABI_PARAM2 ::Gen::RSI +#define ABI_PARAM3 ::Gen::RDX +#define ABI_PARAM4 ::Gen::RCX +#define ABI_PARAM5 ::Gen::R8 +#define ABI_PARAM6 ::Gen::R9 // TODO: Avoid pushing all 16 XMM registers when possible. Most functions we call probably // don't actually clobber them. #define ABI_ALL_CALLER_SAVED \ - (BitSet32 { RAX, RCX, RDX, RDI, RSI, R8, R9, R10, R11 } | \ + (BitSet32 { ::Gen::RAX, ::Gen::RCX, ::Gen::RDX, ::Gen::RDI, ::Gen::RSI, ::Gen::R8, ::Gen::R9, ::Gen::R10, ::Gen::R11 } | \ ABI_ALL_FPRS) #endif // WIN32 #define ABI_ALL_CALLEE_SAVED (~ABI_ALL_CALLER_SAVED) -#define ABI_RETURN RAX +#define ABI_RETURN ::Gen::RAX diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt index a8d891689..ecc200938 100644 --- a/src/core/CMakeLists.txt +++ b/src/core/CMakeLists.txt @@ -1,6 +1,8 @@ set(SRCS arm/disassembler/arm_disasm.cpp arm/disassembler/load_symbol_map.cpp + arm/decoder/arm.cpp + arm/decoder/thumb.cpp arm/dyncom/arm_dyncom.cpp arm/dyncom/arm_dyncom_dec.cpp arm/dyncom/arm_dyncom_interpreter.cpp @@ -129,6 +131,7 @@ set(HEADERS arm/arm_interface.h arm/disassembler/arm_disasm.h arm/disassembler/load_symbol_map.h + arm/decoder/decoder.h arm/dyncom/arm_dyncom.h arm/dyncom/arm_dyncom_dec.h arm/dyncom/arm_dyncom_interpreter.h @@ -261,6 +264,46 @@ set(HEADERS system.h ) +if(ARCHITECTURE_x86_64) + set(SRCS ${SRCS} + arm/jit_x64/cond.cpp + arm/jit_x64/instructions/branch.cpp + arm/jit_x64/instructions/coprocessor.cpp + arm/jit_x64/instructions/data_processing.cpp + arm/jit_x64/instructions/exception_generating.cpp + arm/jit_x64/instructions/extension.cpp + arm/jit_x64/instructions/hint.cpp + arm/jit_x64/instructions/load_store.cpp + arm/jit_x64/instructions/misc.cpp + arm/jit_x64/instructions/usad.cpp + arm/jit_x64/instructions/packing.cpp + arm/jit_x64/instructions/reversal.cpp + arm/jit_x64/instructions/saturation.cpp + arm/jit_x64/instructions/multiply.cpp + arm/jit_x64/instructions/parallel_add_subtract_modulo.cpp + arm/jit_x64/instructions/parallel_add_subtract_saturating.cpp + arm/jit_x64/instructions/parallel_add_subtract_halving.cpp + arm/jit_x64/instructions/qadd_qsub.cpp + arm/jit_x64/instructions/synchronisation.cpp + arm/jit_x64/instructions/status_register.cpp + arm/jit_x64/instructions/thumb.cpp + arm/jit_x64/instructions/helper/load_store.cpp + arm/jit_x64/interface.cpp + arm/jit_x64/interpret.cpp + arm/jit_x64/jit_x64.cpp + arm/jit_x64/reg_alloc.cpp + ) + + set(HEADERS ${HEADERS} + arm/jit_x64/common.h + arm/jit_x64/instructions/helper/load_store.h + arm/jit_x64/interface.h + arm/jit_x64/jit_x64.h + arm/jit_x64/reg_alloc.h + ) +endif() + + create_directory_groups(${SRCS} ${HEADERS}) add_library(core STATIC ${SRCS} ${HEADERS}) diff --git a/src/core/arm/arm_interface.h b/src/core/arm/arm_interface.h index 533067d4f..70462b407 100644 --- a/src/core/arm/arm_interface.h +++ b/src/core/arm/arm_interface.h @@ -148,6 +148,9 @@ public: s64 down_count = 0; ///< A decreasing counter of remaining cycles before the next event, decreased by the cpu run loop + /// Clears any cached state. Call when instructions in memory change to avoid executing stale cached instructions (e.g.: CROs). + virtual void ClearCache() = 0; + protected: /** diff --git a/src/core/arm/decoder/arm.cpp b/src/core/arm/decoder/arm.cpp new file mode 100644 index 000000000..2c4fc65d0 --- /dev/null +++ b/src/core/arm/decoder/arm.cpp @@ -0,0 +1,393 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include +#include + +#include + +#include "common/assert.h" +#include "common/common_types.h" + +#include "core/arm/decoder/decoder.h" + +namespace ArmDecoder { + +namespace Impl { + // Internal implementation for call + template + void call_impl(std::integer_sequence, Visitor* v, void (Visitor::*fn)(Args...), const Container& list) { + using FunctionArgTypes = typename std::tuple; + // Here we static_cast each element in list to the corresponding argument type for fn. + (v->*fn)(static_cast::type>(std::get(list))...); + } + + /** + * This function takes a member function of Visitor and calls it with the parameters specified in list. + * @tparam NumArgs Number of arguments that the member function fn has. + * @param v The Visitor. + * @param fn Member function to call on v. + * @param list List of arguments that will be splatted. + */ + template + void call(Visitor* v, void (Visitor::*fn)(Args...), const Container& list) { + call_impl(typename std::index_sequence_for{}, v, fn, list); + } + + /// Function has NumArgs arguments + template + struct MatcherImpl : ArmMatcher { + std::array masks = {}; + std::array shifts = {}; + Function fn = nullptr; + void visit(Visitor *v, u32 inst) override { + std::array values; + std::transform(masks.begin(), masks.begin() + NumArgs, shifts.begin(), values.begin(), + [inst](u32 mask, size_t shift) { return (inst & mask) >> shift; }); + call(v, fn, values); + } + }; +} + +template +static std::unique_ptr MakeMatcher(const char* const format, Function fn) { + ASSERT(strlen(format) == 32); + + auto ret = std::make_unique>(); + ret->fn = fn; + ret->masks.fill(0); + ret->shifts.fill(0); + + char ch = 0; + int arg = -1; + + for (size_t i = 0; i < 32; i++) { + const size_t bit_position = 31 - i; + const u32 bit = 1 << bit_position; + + if (format[i] == '0') { + // 0: A zero must be found here + ret->bit_mask |= bit; + ch = 0; + continue; + } else if (format[i] == '1') { + // 1: A one must be found here + ret->bit_mask |= bit; + ret->expected |= bit; + ch = 0; + continue; + } else if (format[i] == '-') { + // -: Ignore this bit + ch = 0; + continue; + } + + // Ban some characters + ASSERT(format[i] != 'I'); + ASSERT(format[i] != 'l'); + ASSERT(format[i] != 'O'); + + // otherwise: This bit is part of a field to extract + + // strings of the same character make up a field + if (format[i] != ch) { + arg++; + ASSERT(arg < NumArgs); + ch = format[i]; + } + + ret->masks[arg] |= bit; + ret->shifts[arg] = bit_position; + } + + ASSERT(arg == NumArgs - 1); + + return std::unique_ptr(std::move(ret)); +} + +static const std::array arm_instruction_table = {{ + // Branch instructions + { "BLX (immediate)", MakeMatcher<2>("1111101hvvvvvvvvvvvvvvvvvvvvvvvv", &Visitor::BLX_imm) }, // ARMv5 + { "BLX (register)", MakeMatcher<2>("cccc000100101111111111110011mmmm", &Visitor::BLX_reg) }, // ARMv5 + { "B", MakeMatcher<2>("cccc1010vvvvvvvvvvvvvvvvvvvvvvvv", &Visitor::B) }, // all + { "BL", MakeMatcher<2>("cccc1011vvvvvvvvvvvvvvvvvvvvvvvv", &Visitor::BL) }, // all + { "BX", MakeMatcher<2>("cccc000100101111111111110001mmmm", &Visitor::BX) }, // ARMv4T + { "BXJ", MakeMatcher<2>("cccc000100101111111111110010mmmm", &Visitor::BXJ) }, // ARMv5J + + // Coprocessor instructions + { "CDP2", MakeMatcher<0>("11111110-------------------1----", &Visitor::CDP) }, // ARMv5 (Generic Coprocessor) + { "CDP", MakeMatcher<0>("----1110-------------------0----", &Visitor::CDP) }, // ARMv2 (Generic Coprocessor) + { "LDC2", MakeMatcher<0>("1111110----1--------------------", &Visitor::LDC) }, // ARMv5 (Generic Coprocessor) + { "LDC", MakeMatcher<0>("----110----1--------------------", &Visitor::LDC) }, // ARMv2 (Generic Coprocessor) + { "MCR2", MakeMatcher<0>("----1110---0---------------1----", &Visitor::MCR) }, // ARMv5 (Generic Coprocessor) + { "MCR", MakeMatcher<0>("----1110---0---------------1----", &Visitor::MCR) }, // ARMv2 (Generic Coprocessor) + { "MCRR2", MakeMatcher<0>("111111000100--------------------", &Visitor::MCRR) }, // ARMv6 (Generic Coprocessor) + { "MCRR", MakeMatcher<0>("----11000100--------------------", &Visitor::MCRR) }, // ARMv5E (Generic Coprocessor) + { "MRC2", MakeMatcher<0>("11111110---1---------------1----", &Visitor::MRC) }, // ARMv5 (Generic Coprocessor) + { "MRC", MakeMatcher<0>("----1110---1---------------1----", &Visitor::MRC) }, // ARMv2 (Generic Coprocessor) + { "MRRC2", MakeMatcher<0>("111111000101--------------------", &Visitor::MRRC) }, // ARMv6 (Generic Coprocessor) + { "MRRC", MakeMatcher<0>("----11000101--------------------", &Visitor::MRRC) }, // ARMv5E (Generic Coprocessor) + { "STC2", MakeMatcher<0>("1111110----0--------------------", &Visitor::STC) }, // ARMv5 (Generic Coprocessor) + { "STC", MakeMatcher<0>("----110----0--------------------", &Visitor::STC) }, // ARMv2 (Generic Coprocessor) + + // Data Processing instructions + { "ADC (imm)", MakeMatcher<6>("cccc0010101Snnnnddddrrrrvvvvvvvv", &Visitor::ADC_imm) }, // all + { "ADC (reg)", MakeMatcher<7>("cccc0000101Snnnnddddvvvvvrr0mmmm", &Visitor::ADC_reg) }, // all + { "ADC (rsr)", MakeMatcher<7>("cccc0000101Snnnnddddssss0rr1mmmm", &Visitor::ADC_rsr) }, // all + { "ADD (imm)", MakeMatcher<6>("cccc0010100Snnnnddddrrrrvvvvvvvv", &Visitor::ADD_imm) }, // all + { "ADD (reg)", MakeMatcher<7>("cccc0000100Snnnnddddvvvvvrr0mmmm", &Visitor::ADD_reg) }, // all + { "ADD (rsr)", MakeMatcher<7>("cccc0000100Snnnnddddssss0rr1mmmm", &Visitor::ADD_rsr) }, // all + { "AND (imm)", MakeMatcher<6>("cccc0010000Snnnnddddrrrrvvvvvvvv", &Visitor::AND_imm) }, // all + { "AND (reg)", MakeMatcher<7>("cccc0000000Snnnnddddvvvvvrr0mmmm", &Visitor::AND_reg) }, // all + { "AND (rsr)", MakeMatcher<7>("cccc0000000Snnnnddddssss0rr1mmmm", &Visitor::AND_rsr) }, // all + { "BIC (imm)", MakeMatcher<6>("cccc0011110Snnnnddddrrrrvvvvvvvv", &Visitor::BIC_imm) }, // all + { "BIC (reg)", MakeMatcher<7>("cccc0001110Snnnnddddvvvvvrr0mmmm", &Visitor::BIC_reg) }, // all + { "BIC (rsr)", MakeMatcher<7>("cccc0001110Snnnnddddssss0rr1mmmm", &Visitor::BIC_rsr) }, // all + { "CMN (imm)", MakeMatcher<4>("cccc00110111nnnn0000rrrrvvvvvvvv", &Visitor::CMN_imm) }, // all + { "CMN (reg)", MakeMatcher<5>("cccc00010111nnnn0000vvvvvrr0mmmm", &Visitor::CMN_reg) }, // all + { "CMN (rsr)", MakeMatcher<5>("cccc00010111nnnn0000ssss0rr1mmmm", &Visitor::CMN_rsr) }, // all + { "CMP (imm)", MakeMatcher<4>("cccc00110101nnnn0000rrrrvvvvvvvv", &Visitor::CMP_imm) }, // all + { "CMP (reg)", MakeMatcher<5>("cccc00010101nnnn0000vvvvvrr0mmmm", &Visitor::CMP_reg) }, // all + { "CMP (rsr)", MakeMatcher<5>("cccc00010101nnnn0000ssss0rr1mmmm", &Visitor::CMP_rsr) }, // all + { "EOR (imm)", MakeMatcher<6>("cccc0010001Snnnnddddrrrrvvvvvvvv", &Visitor::EOR_imm) }, // all + { "EOR (reg)", MakeMatcher<7>("cccc0000001Snnnnddddvvvvvrr0mmmm", &Visitor::EOR_reg) }, // all + { "EOR (rsr)", MakeMatcher<7>("cccc0000001Snnnnddddssss0rr1mmmm", &Visitor::EOR_rsr) }, // all + { "MOV (imm)", MakeMatcher<5>("cccc0011101S0000ddddrrrrvvvvvvvv", &Visitor::MOV_imm) }, // all + { "MOV (reg)", MakeMatcher<6>("cccc0001101S0000ddddvvvvvrr0mmmm", &Visitor::MOV_reg) }, // all + { "MOV (rsr)", MakeMatcher<6>("cccc0001101S0000ddddssss0rr1mmmm", &Visitor::MOV_rsr) }, // all + { "MVN (imm)", MakeMatcher<5>("cccc0011111S0000ddddrrrrvvvvvvvv", &Visitor::MVN_imm) }, // all + { "MVN (reg)", MakeMatcher<6>("cccc0001111S0000ddddvvvvvrr0mmmm", &Visitor::MVN_reg) }, // all + { "MVN (rsr)", MakeMatcher<6>("cccc0001111S0000ddddssss0rr1mmmm", &Visitor::MVN_rsr) }, // all + { "ORR (imm)", MakeMatcher<6>("cccc0011100Snnnnddddrrrrvvvvvvvv", &Visitor::ORR_imm) }, // all + { "ORR (reg)", MakeMatcher<7>("cccc0001100Snnnnddddvvvvvrr0mmmm", &Visitor::ORR_reg) }, // all + { "ORR (rsr)", MakeMatcher<7>("cccc0001100Snnnnddddssss0rr1mmmm", &Visitor::ORR_rsr) }, // all + { "RSB (imm)", MakeMatcher<6>("cccc0010011Snnnnddddrrrrvvvvvvvv", &Visitor::RSB_imm) }, // all + { "RSB (reg)", MakeMatcher<7>("cccc0000011Snnnnddddvvvvvrr0mmmm", &Visitor::RSB_reg) }, // all + { "RSB (rsr)", MakeMatcher<7>("cccc0000011Snnnnddddssss0rr1mmmm", &Visitor::RSB_rsr) }, // all + { "RSC (imm)", MakeMatcher<6>("cccc0010111Snnnnddddrrrrvvvvvvvv", &Visitor::RSC_imm) }, // all + { "RSC (reg)", MakeMatcher<7>("cccc0000111Snnnnddddvvvvvrr0mmmm", &Visitor::RSC_reg) }, // all + { "RSC (rsr)", MakeMatcher<7>("cccc0000111Snnnnddddssss0rr1mmmm", &Visitor::RSC_rsr) }, // all + { "SBC (imm)", MakeMatcher<6>("cccc0010110Snnnnddddrrrrvvvvvvvv", &Visitor::SBC_imm) }, // all + { "SBC (reg)", MakeMatcher<7>("cccc0000110Snnnnddddvvvvvrr0mmmm", &Visitor::SBC_reg) }, // all + { "SBC (rsr)", MakeMatcher<7>("cccc0000110Snnnnddddssss0rr1mmmm", &Visitor::SBC_rsr) }, // all + { "SUB (imm)", MakeMatcher<6>("cccc0010010Snnnnddddrrrrvvvvvvvv", &Visitor::SUB_imm) }, // all + { "SUB (reg)", MakeMatcher<7>("cccc0000010Snnnnddddvvvvvrr0mmmm", &Visitor::SUB_reg) }, // all + { "SUB (rsr)", MakeMatcher<7>("cccc0000010Snnnnddddssss0rr1mmmm", &Visitor::SUB_rsr) }, // all + { "TEQ (imm)", MakeMatcher<4>("cccc00110011nnnn0000rrrrvvvvvvvv", &Visitor::TEQ_imm) }, // all + { "TEQ (reg)", MakeMatcher<5>("cccc00010011nnnn0000vvvvvrr0mmmm", &Visitor::TEQ_reg) }, // all + { "TEQ (rsr)", MakeMatcher<5>("cccc00010011nnnn0000ssss0rr1mmmm", &Visitor::TEQ_rsr) }, // all + { "TST (imm)", MakeMatcher<4>("cccc00110001nnnn0000rrrrvvvvvvvv", &Visitor::TST_imm) }, // all + { "TST (reg)", MakeMatcher<5>("cccc00010001nnnn0000vvvvvrr0mmmm", &Visitor::TST_reg) }, // all + { "TST (rsr)", MakeMatcher<5>("cccc00010001nnnn0000ssss0rr1mmmm", &Visitor::TST_rsr) }, // all + + // Exception Generating instructions + { "BKPT", MakeMatcher<3>("cccc00010010vvvvvvvvvvvv0111vvvv", &Visitor::BKPT) }, // ARMv5 + { "SVC", MakeMatcher<2>("cccc1111vvvvvvvvvvvvvvvvvvvvvvvv", &Visitor::SVC) }, // all + { "UDF", MakeMatcher<0>("111001111111------------1111----", &Visitor::UDF) }, // all + + // Extension instructions + { "SXTB", MakeMatcher<4>("cccc011010101111ddddrr000111mmmm", &Visitor::SXTB) }, // ARMv6 + { "SXTB16", MakeMatcher<4>("cccc011010001111ddddrr000111mmmm", &Visitor::SXTB16) }, // ARMv6 + { "SXTH", MakeMatcher<4>("cccc011010111111ddddrr000111mmmm", &Visitor::SXTH) }, // ARMv6 + { "SXTAB", MakeMatcher<5>("cccc01101010nnnnddddrr000111mmmm", &Visitor::SXTAB) }, // ARMv6 + { "SXTAB16", MakeMatcher<5>("cccc01101000nnnnddddrr000111mmmm", &Visitor::SXTAB16) }, // ARMv6 + { "SXTAH", MakeMatcher<5>("cccc01101011nnnnddddrr000111mmmm", &Visitor::SXTAH) }, // ARMv6 + { "UXTB", MakeMatcher<4>("cccc011011101111ddddrr000111mmmm", &Visitor::UXTB) }, // ARMv6 + { "UXTB16", MakeMatcher<4>("cccc011011001111ddddrr000111mmmm", &Visitor::UXTB16) }, // ARMv6 + { "UXTH", MakeMatcher<4>("cccc011011111111ddddrr000111mmmm", &Visitor::UXTH) }, // ARMv6 + { "UXTAB", MakeMatcher<5>("cccc01101110nnnnddddrr000111mmmm", &Visitor::UXTAB) }, // ARMv6 + { "UXTAB16", MakeMatcher<5>("cccc01101100nnnnddddrr000111mmmm", &Visitor::UXTAB16) }, // ARMv6 + { "UXTAH", MakeMatcher<5>("cccc01101111nnnnddddrr000111mmmm", &Visitor::UXTAH) }, // ARMv6 + + // Hint instructions + { "PLD", MakeMatcher<0>("111101---101----1111------------", &Visitor::PLD) }, // ARMv5E + { "SEV", MakeMatcher<0>("----0011001000001111000000000100", &Visitor::SEV) }, // ARMv6K + { "WFE", MakeMatcher<0>("----0011001000001111000000000010", &Visitor::WFE) }, // ARMv6K + { "WFI", MakeMatcher<0>("----0011001000001111000000000011", &Visitor::WFI) }, // ARMv6K + { "YIELD", MakeMatcher<0>("----0011001000001111000000000001", &Visitor::YIELD) }, // ARMv6K + + // Synchronization Primitive instructions + { "CLREX", MakeMatcher<0>("11110101011111111111000000011111", &Visitor::CLREX) }, // ARMv6K + { "LDREX", MakeMatcher<3>("cccc00011001nnnndddd111110011111", &Visitor::LDREX) }, // ARMv6 + { "LDREXB", MakeMatcher<3>("cccc00011101nnnndddd111110011111", &Visitor::LDREXB) }, // ARMv6K + { "LDREXD", MakeMatcher<3>("cccc00011011nnnndddd111110011111", &Visitor::LDREXD) }, // ARMv6K + { "LDREXH", MakeMatcher<3>("cccc00011111nnnndddd111110011111", &Visitor::LDREXH) }, // ARMv6K + { "STREX", MakeMatcher<4>("cccc00011000nnnndddd11111001mmmm", &Visitor::STREX) }, // ARMv6 + { "STREXB", MakeMatcher<4>("cccc00011100nnnndddd11111001mmmm", &Visitor::STREXB) }, // ARMv6K + { "STREXD", MakeMatcher<4>("cccc00011010nnnndddd11111001mmmm", &Visitor::STREXD) }, // ARMv6K + { "STREXH", MakeMatcher<4>("cccc00011110nnnndddd11111001mmmm", &Visitor::STREXH) }, // ARMv6K + { "SWP", MakeMatcher<4>("cccc00010000nnnndddd00001001mmmm", &Visitor::SWP) }, // ARMv2S (Deprecated in ARMv6) + { "SWPB", MakeMatcher<4>("cccc00010100nnnndddd00001001mmmm", &Visitor::SWPB) }, // ARMv2S (Deprecated in ARMv6) + + // Load/Store instructions + { "LDR (imm)", MakeMatcher<7>("cccc010pu0w1nnnnddddvvvvvvvvvvvv", &Visitor::LDR_imm) }, + { "LDR (reg)", MakeMatcher<9>("cccc011pu0w1nnnnddddvvvvvrr0mmmm", &Visitor::LDR_reg) }, + { "LDRB (imm)", MakeMatcher<7>("cccc010pu1w1nnnnddddvvvvvvvvvvvv", &Visitor::LDRB_imm) }, + { "LDRB (reg)", MakeMatcher<9>("cccc011pu1w1nnnnddddvvvvvrr0mmmm", &Visitor::LDRB_reg) }, + { "LDRBT (A1)", MakeMatcher<0>("----0100-111--------------------", &Visitor::LDRBT) }, + { "LDRBT (A2)", MakeMatcher<0>("----0110-111---------------0----", &Visitor::LDRBT) }, + { "LDRD (imm)", MakeMatcher<8>("cccc000pu1w0nnnnddddvvvv1101vvvv", &Visitor::LDRD_imm) }, // ARMv5E + { "LDRD (reg)", MakeMatcher<7>("cccc000pu0w0nnnndddd00001101mmmm", &Visitor::LDRD_reg) }, // ARMv5E + { "LDRH (imm)", MakeMatcher<8>("cccc000pu1w1nnnnddddvvvv1011vvvv", &Visitor::LDRH_imm) }, + { "LDRH (reg)", MakeMatcher<7>("cccc000pu0w1nnnndddd00001011mmmm", &Visitor::LDRH_reg) }, + { "LDRHT (A1)", MakeMatcher<0>("----0000-111------------1011----", &Visitor::LDRHT) }, + { "LDRHT (A2)", MakeMatcher<0>("----0000-011--------00001011----", &Visitor::LDRHT) }, + { "LDRSB (imm)", MakeMatcher<8>("cccc000pu1w1nnnnddddvvvv1101vvvv", &Visitor::LDRSB_imm) }, + { "LDRSB (reg)", MakeMatcher<7>("cccc000pu0w1nnnndddd00001101mmmm", &Visitor::LDRSB_reg) }, + { "LDRSBT (A1)", MakeMatcher<0>("----0000-111------------1101----", &Visitor::LDRSBT) }, + { "LDRSBT (A2)", MakeMatcher<0>("----0000-011--------00001101----", &Visitor::LDRSBT) }, + { "LDRSH (imm)", MakeMatcher<8>("cccc000pu1w1nnnnddddvvvv1111vvvv", &Visitor::LDRSH_imm) }, + { "LDRSH (reg)", MakeMatcher<7>("cccc000pu0w1nnnndddd00001111mmmm", &Visitor::LDRSH_reg) }, + { "LDRSHT (A1)", MakeMatcher<0>("----0000-111------------1111----", &Visitor::LDRSHT) }, + { "LDRSHT (A2)", MakeMatcher<0>("----0000-011--------00001111----", &Visitor::LDRSHT) }, + { "LDRT (A1)", MakeMatcher<0>("----0100-011--------------------", &Visitor::LDRT) }, + { "LDRT (A2)", MakeMatcher<0>("----0110-011---------------0----", &Visitor::LDRT) }, + { "STR (imm)", MakeMatcher<7>("cccc010pu0w0nnnnddddvvvvvvvvvvvv", &Visitor::STR_imm) }, + { "STR (reg)", MakeMatcher<9>("cccc011pu0w0nnnnddddvvvvvrr0mmmm", &Visitor::STR_reg) }, + { "STRB (imm)", MakeMatcher<7>("cccc010pu1w0nnnnddddvvvvvvvvvvvv", &Visitor::STRB_imm) }, + { "STRB (reg)", MakeMatcher<9>("cccc011pu1w0nnnnddddvvvvvrr0mmmm", &Visitor::STRB_reg) }, + { "STRBT (A1)", MakeMatcher<0>("----0100-110--------------------", &Visitor::STRBT) }, + { "STRBT (A2)", MakeMatcher<0>("----0110-110---------------0----", &Visitor::STRBT) }, + { "STRD (imm)", MakeMatcher<8>("cccc000pu1w0nnnnddddvvvv1111vvvv", &Visitor::STRD_imm) }, // ARMv5E + { "STRD (reg)", MakeMatcher<7>("cccc000pu0w0nnnndddd00001111mmmm", &Visitor::STRD_reg) }, // ARMv5E + { "STRH (imm)", MakeMatcher<8>("cccc000pu1w0nnnnddddvvvv1011vvvv", &Visitor::STRH_imm) }, + { "STRH (reg)", MakeMatcher<7>("cccc000pu0w0nnnndddd00001011mmmm", &Visitor::STRH_reg) }, + { "STRHT (A1)", MakeMatcher<0>("----0000-110------------1011----", &Visitor::STRHT) }, + { "STRHT (A2)", MakeMatcher<0>("----0000-010--------00001011----", &Visitor::STRHT) }, + { "STRT (A1)", MakeMatcher<0>("----0100-010--------------------", &Visitor::STRT) }, + { "STRT (A2)", MakeMatcher<0>("----0110-010---------------0----", &Visitor::STRT) }, + + // Load/Store Multiple instructions + { "LDM", MakeMatcher<6>("cccc100pu0w1nnnnxxxxxxxxxxxxxxxx", &Visitor::LDM) }, // all + { "LDM (usr reg)", MakeMatcher<0>("----100--101--------------------", &Visitor::LDM_usr) }, // all + { "LDM (exce ret)", MakeMatcher<0>("----100--1-1----1---------------", &Visitor::LDM_eret) }, // all + { "STM", MakeMatcher<6>("cccc100pu0w0nnnnxxxxxxxxxxxxxxxx", &Visitor::STM) }, // all + { "STM (usr reg)", MakeMatcher<0>("----100--100--------------------", &Visitor::STM_usr) }, // all + + // Miscellaneous instructions + { "CLZ", MakeMatcher<3>("cccc000101101111dddd11110001mmmm", &Visitor::CLZ) }, // ARMv5 + { "NOP", MakeMatcher<0>("----001100100000111100000000----", &Visitor::NOP) }, // ARMv6K + { "SEL", MakeMatcher<4>("cccc01101000nnnndddd11111011mmmm", &Visitor::SEL) }, // ARMv6 + + // Unsigned Sum of Absolute Differences instructions + { "USAD8", MakeMatcher<4>("cccc01111000dddd1111mmmm0001nnnn", &Visitor::USAD8) }, // ARMv6 + { "USADA8", MakeMatcher<5>("cccc01111000ddddaaaammmm0001nnnn", &Visitor::USADA8) }, // ARMv6 + + // Packing instructions + { "PKHBT", MakeMatcher<5>("cccc01101000nnnnddddvvvvv001mmmm", &Visitor::PKHBT) }, // ARMv6K + { "PKHTB", MakeMatcher<5>("cccc01101000nnnnddddvvvvv101mmmm", &Visitor::PKHTB) }, // ARMv6K + + // Reversal instructions + { "REV", MakeMatcher<3>("cccc011010111111dddd11110011mmmm", &Visitor::REV) }, // ARMv6 + { "REV16", MakeMatcher<3>("cccc011010111111dddd11111011mmmm", &Visitor::REV16) }, // ARMv6 + { "REVSH", MakeMatcher<3>("cccc011011111111dddd11111011mmmm", &Visitor::REVSH) }, // ARMv6 + + // Saturation instructions + { "SSAT", MakeMatcher<6>("cccc0110101vvvvvddddvvvvvr01nnnn", &Visitor::SSAT) }, // ARMv6 + { "SSAT16", MakeMatcher<4>("cccc01101010vvvvdddd11110011nnnn", &Visitor::SSAT16) }, // ARMv6 + { "USAT", MakeMatcher<6>("cccc0110111vvvvvddddvvvvvr01nnnn", &Visitor::USAT) }, // ARMv6 + { "USAT16", MakeMatcher<4>("cccc01101110vvvvdddd11110011nnnn", &Visitor::USAT16) }, // ARMv6 + + // Multiply (Normal) instructions + { "MLA", MakeMatcher<6>("cccc0000001Sddddaaaammmm1001nnnn", &Visitor::MLA) }, // ARMv2 + { "MUL", MakeMatcher<5>("cccc0000000Sdddd0000mmmm1001nnnn", &Visitor::MUL) }, // ARMv2 + + // Multiply (Long) instructions + { "SMLAL", MakeMatcher<6>("cccc0000111Sddddaaaammmm1001nnnn", &Visitor::SMLAL) }, // ARMv3M + { "SMULL", MakeMatcher<6>("cccc0000110Sddddaaaammmm1001nnnn", &Visitor::SMULL) }, // ARMv3M + { "UMAAL", MakeMatcher<5>("cccc00000100ddddaaaammmm1001nnnn", &Visitor::UMAAL) }, // ARMv6 + { "UMLAL", MakeMatcher<6>("cccc0000101Sddddaaaammmm1001nnnn", &Visitor::UMLAL) }, // ARMv3M + { "UMULL", MakeMatcher<6>("cccc0000100Sddddaaaammmm1001nnnn", &Visitor::UMULL) }, // ARMv3M + + // Multiply (Halfword) instructions + { "SMLALXY", MakeMatcher<7>("cccc00010100ddddaaaammmm1xy0nnnn", &Visitor::SMLALxy) }, // ARMv5xP + { "SMLAXY", MakeMatcher<7>("cccc00010000ddddaaaammmm1xy0nnnn", &Visitor::SMLAxy) }, // ARMv5xP + { "SMULXY", MakeMatcher<6>("cccc00010110dddd0000mmmm1xy0nnnn", &Visitor::SMULxy) }, // ARMv5xP + + // Multiply (Word by Halfword) instructions + { "SMLAWY", MakeMatcher<6>("cccc00010010ddddaaaammmm1y00nnnn", &Visitor::SMLAWy) }, // ARMv5xP + { "SMULWY", MakeMatcher<5>("cccc00010010dddd0000mmmm1y10nnnn", &Visitor::SMULWy) }, // ARMv5xP + + // Multiply (Most Significant Word) instructions + { "SMMUL", MakeMatcher<5>("cccc01110101dddd1111mmmm00R1nnnn", &Visitor::SMMUL) }, // ARMv6 + { "SMMLA", MakeMatcher<6>("cccc01110101ddddaaaammmm00R1nnnn", &Visitor::SMMLA) }, // ARMv6 + { "SMMLS", MakeMatcher<6>("cccc01110101ddddaaaammmm11R1nnnn", &Visitor::SMMLS) }, // ARMv6 + + // Multiply (Dual) instructions + { "SMLAD", MakeMatcher<6>("cccc01110000ddddaaaammmm00M1nnnn", &Visitor::SMLAD) }, // ARMv6 + { "SMLALD", MakeMatcher<6>("cccc01110100ddddaaaammmm00M1nnnn", &Visitor::SMLALD) }, // ARMv6 + { "SMLSD", MakeMatcher<6>("cccc01110000ddddaaaammmm01M1nnnn", &Visitor::SMLSD) }, // ARMv6 + { "SMLSLD", MakeMatcher<6>("cccc01110100ddddaaaammmm01M1nnnn", &Visitor::SMLSLD) }, // ARMv6 + { "SMUAD", MakeMatcher<5>("cccc01110000dddd1111mmmm00M1nnnn", &Visitor::SMUAD) }, // ARMv6 + { "SMUSD", MakeMatcher<5>("cccc01110000dddd1111mmmm01M1nnnn", &Visitor::SMUSD) }, // ARMv6 + + // Parallel Add/Subtract (Modulo) instructions + { "SADD8", MakeMatcher<4>("cccc01100001nnnndddd11111001mmmm", &Visitor::SADD8) }, // ARMv6 + { "SADD16", MakeMatcher<4>("cccc01100001nnnndddd11110001mmmm", &Visitor::SADD16) }, // ARMv6 + { "SASX", MakeMatcher<4>("cccc01100001nnnndddd11110011mmmm", &Visitor::SASX) }, // ARMv6 + { "SSAX", MakeMatcher<4>("cccc01100001nnnndddd11110101mmmm", &Visitor::SSAX) }, // ARMv6 + { "SSUB8", MakeMatcher<4>("cccc01100001nnnndddd11111111mmmm", &Visitor::SSUB8) }, // ARMv6 + { "SSUB16", MakeMatcher<4>("cccc01100001nnnndddd11110111mmmm", &Visitor::SSUB16) }, // ARMv6 + { "UADD8", MakeMatcher<4>("cccc01100101nnnndddd11111001mmmm", &Visitor::UADD8) }, // ARMv6 + { "UADD16", MakeMatcher<4>("cccc01100101nnnndddd11110001mmmm", &Visitor::UADD16) }, // ARMv6 + { "UASX", MakeMatcher<4>("cccc01100101nnnndddd11110011mmmm", &Visitor::UASX) }, // ARMv6 + { "USAX", MakeMatcher<4>("cccc01100101nnnndddd11110101mmmm", &Visitor::USAX) }, // ARMv6 + { "USUB8", MakeMatcher<4>("cccc01100101nnnndddd11111111mmmm", &Visitor::USUB8) }, // ARMv6 + { "USUB16", MakeMatcher<4>("cccc01100101nnnndddd11110111mmmm", &Visitor::USUB16) }, // ARMv6 + + // Parallel Add/Subtract (Saturating) instructions + { "QADD8", MakeMatcher<4>("cccc01100010nnnndddd11111001mmmm", &Visitor::QADD8) }, // ARMv6 + { "QADD16", MakeMatcher<4>("cccc01100010nnnndddd11110001mmmm", &Visitor::QADD16) }, // ARMv6 + { "QASX", MakeMatcher<4>("cccc01100010nnnndddd11110011mmmm", &Visitor::QASX) }, // ARMv6 + { "QSAX", MakeMatcher<4>("cccc01100010nnnndddd11110101mmmm", &Visitor::QSAX) }, // ARMv6 + { "QSUB8", MakeMatcher<4>("cccc01100010nnnndddd11111111mmmm", &Visitor::QSUB8) }, // ARMv6 + { "QSUB16", MakeMatcher<4>("cccc01100010nnnndddd11110111mmmm", &Visitor::QSUB16) }, // ARMv6 + { "UQADD8", MakeMatcher<4>("cccc01100110nnnndddd11111001mmmm", &Visitor::UQADD8) }, // ARMv6 + { "UQADD16", MakeMatcher<4>("cccc01100110nnnndddd11110001mmmm", &Visitor::UQADD16) }, // ARMv6 + { "UQASX", MakeMatcher<4>("cccc01100110nnnndddd11110011mmmm", &Visitor::UQASX) }, // ARMv6 + { "UQSAX", MakeMatcher<4>("cccc01100110nnnndddd11110101mmmm", &Visitor::UQSAX) }, // ARMv6 + { "UQSUB8", MakeMatcher<4>("cccc01100110nnnndddd11111111mmmm", &Visitor::UQSUB8) }, // ARMv6 + { "UQSUB16", MakeMatcher<4>("cccc01100110nnnndddd11110111mmmm", &Visitor::UQSUB16) }, // ARMv6 + + // Parallel Add/Subtract (Halving) instructions + { "SHADD8", MakeMatcher<4>("cccc01100011nnnndddd11111001mmmm", &Visitor::SHADD8) }, // ARMv6 + { "SHADD16", MakeMatcher<4>("cccc01100011nnnndddd11110001mmmm", &Visitor::SHADD16) }, // ARMv6 + { "SHASX", MakeMatcher<4>("cccc01100011nnnndddd11110011mmmm", &Visitor::SHASX) }, // ARMv6 + { "SHSAX", MakeMatcher<4>("cccc01100011nnnndddd11110101mmmm", &Visitor::SHSAX) }, // ARMv6 + { "SHSUB8", MakeMatcher<4>("cccc01100011nnnndddd11111111mmmm", &Visitor::SHSUB8) }, // ARMv6 + { "SHSUB16", MakeMatcher<4>("cccc01100011nnnndddd11110111mmmm", &Visitor::SHSUB16) }, // ARMv6 + { "UHADD8", MakeMatcher<4>("cccc01100111nnnndddd11111001mmmm", &Visitor::UHADD8) }, // ARMv6 + { "UHADD16", MakeMatcher<4>("cccc01100111nnnndddd11110001mmmm", &Visitor::UHADD16) }, // ARMv6 + { "UHASX", MakeMatcher<4>("cccc01100111nnnndddd11110011mmmm", &Visitor::UHASX) }, // ARMv6 + { "UHSAX", MakeMatcher<4>("cccc01100111nnnndddd11110101mmmm", &Visitor::UHSAX) }, // ARMv6 + { "UHSUB8", MakeMatcher<4>("cccc01100111nnnndddd11111111mmmm", &Visitor::UHSUB8) }, // ARMv6 + { "UHSUB16", MakeMatcher<4>("cccc01100111nnnndddd11110111mmmm", &Visitor::UHSUB16) }, // ARMv6 + + // Saturated Add/Subtract instructions + { "QADD", MakeMatcher<4>("cccc00010000nnnndddd00000101mmmm", &Visitor::QADD) }, // ARMv5xP + { "QSUB", MakeMatcher<4>("cccc00010010nnnndddd00000101mmmm", &Visitor::QSUB) }, // ARMv5xP + { "QDADD", MakeMatcher<4>("cccc00010100nnnndddd00000101mmmm", &Visitor::QDADD) }, // ARMv5xP + { "QDSUB", MakeMatcher<4>("cccc00010110nnnndddd00000101mmmm", &Visitor::QDSUB) }, // ARMv5xP + + // Status Register Access instructions + { "CPS", MakeMatcher<0>("111100010000---00000000---0-----", &Visitor::CPS) }, // ARMv6 + { "SETEND", MakeMatcher<1>("1111000100000001000000e000000000", &Visitor::SETEND) }, // ARMv6 + { "MRS", MakeMatcher<0>("----00010-00--------00--00000000", &Visitor::MRS) }, // ARMv3 + { "MSR", MakeMatcher<0>("----00-10-10----1111------------", &Visitor::MSR) }, // ARMv3 + { "RFE", MakeMatcher<0>("----0001101-0000---------110----", &Visitor::RFE) }, // ARMv6 + { "SRS", MakeMatcher<0>("0000011--0-00000000000000001----", &Visitor::SRS) }, // ARMv6 +}}; + +boost::optional DecodeArm(u32 i) { + auto iterator = std::find_if(arm_instruction_table.cbegin(), arm_instruction_table.cend(), + [i](const auto& instruction) { return instruction.Match(i); }); + + return iterator != arm_instruction_table.cend() ? boost::make_optional(*iterator) : boost::none; +} + +} // namespace ArmDecoder diff --git a/src/core/arm/decoder/decoder.h b/src/core/arm/decoder/decoder.h new file mode 100644 index 000000000..212a9d0eb --- /dev/null +++ b/src/core/arm/decoder/decoder.h @@ -0,0 +1,415 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +#include + +#include "common/assert.h" +#include "common/common_types.h" + +namespace ArmDecoder { + +// This is a generic ARMv6K decoder using double dispatch. + +class ArmInstruction; +class ThumbInstruction; +class Visitor; + +/** + * This function identifies an ARM instruction and returns the relevant ArmInstruction. + * Returns boost::none if the instruction was not recognised. + */ +boost::optional DecodeArm(u32 instruction); + +/** +* This function identifies a Thumb instruction and returns the relevant ThumbInstruction. +* Returns boost::none if the instruction was not recognised. +*/ +boost::optional DecodeThumb(u16 instruction); + +/// INTERNAL +struct ArmMatcher { + u32 bit_mask; + u32 expected; + bool Match(u32 x) const { + return (x & bit_mask) == expected; + } + virtual void visit(Visitor* v, u32 inst) = 0; +}; + +/** + * This structure represents a decoder for a specific ARM instruction. + * Calling Visit calls the relevant function on Visitor. + */ +class ArmInstruction final { +public: + ArmInstruction(const char* const name, std::unique_ptr matcher) : name(name), matcher(std::move(matcher)) {} + + const char* Name() const { + return name; + } + + bool Match(u32 instruction) const { + return matcher->Match(instruction); + } + + void Visit(Visitor* v, u32 instruction) const { + matcher->visit(v, instruction); + } + +private: + const char* const name; + const std::unique_ptr matcher; +}; + +/// INTERNAL +struct ThumbMatcher { + u16 bit_mask; + u16 expected; + bool Match(u16 x) const { + return (x & bit_mask) == expected; + } + std::function visit; +}; + +/** + * This structure represents a decoder for a specific Thumb instruction. + * Calling Visit calls the relevant function on Visitor. + */ +class ThumbInstruction final { +public: + ThumbInstruction(const char* const name, ThumbMatcher&& matcher) : name(name), matcher(std::move(matcher)) {} + + const char* Name() const { + return name; + } + + bool Match(u16 instruction) const { + return matcher.Match(instruction); + } + + void Visit(Visitor* v, u16 instruction) const { + matcher.visit(v, instruction); + } + +private: + const char* const name; + const ThumbMatcher matcher; +}; + +enum class Cond { + EQ, NE, CS, CC, MI, PL, VS, VC, HI, LS, GE, LT, GT, LE, AL, NV +}; + +using Imm4 = u32; +using Imm5 = u32; +using Imm8 = u32; +using Imm11 = u32; +using Imm12 = u32; +using Imm24 = u32; +using RegisterList = u16; + +enum class Register { + R0, R1, R2, R3, R4, R5, R6, R7, R8, R9, R10, R11, R12, R13, R14, R15, + SP = R13, + LR = R14, + PC = R15, + INVALID_REG = 99 +}; + +inline Register operator+ (Register arm_reg, int number) { + ASSERT(arm_reg != Register::INVALID_REG); + + int value = static_cast(arm_reg) + number; + ASSERT(value >= 0 && value <= 15); + + return static_cast(value); +} + +enum class ShiftType { + LSL, + LSR, + ASR, + ROR ///< RRX falls under this too +}; + +enum class SignExtendRotation { + ROR_0, ///< ROR #0 or omitted + ROR_8, ///< ROR #8 + ROR_16, ///< ROR #16 + ROR_24 ///< ROR #24 +}; + +class Visitor { +public: + virtual ~Visitor() = default; + + // Branch instructions + virtual void B(Cond cond, Imm24 imm24) = 0; + virtual void BL(Cond cond, Imm24 imm24) = 0; + virtual void BLX_imm(bool H, Imm24 imm24) = 0; + virtual void BLX_reg(Cond cond, Register Rm) = 0; + virtual void BX(Cond cond, Register Rm) = 0; + virtual void BXJ(Cond cond, Register Rm) = 0; + + // Coprocessor instructions + virtual void CDP() = 0; + virtual void LDC() = 0; + virtual void MCR() = 0; + virtual void MCRR() = 0; + virtual void MRC() = 0; + virtual void MRRC() = 0; + virtual void STC() = 0; + + // Data processing instructions + virtual void ADC_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void ADC_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void ADC_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void ADD_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void ADD_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void ADD_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void AND_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void AND_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void AND_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void BIC_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void BIC_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void BIC_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void CMN_imm(Cond cond, Register Rn, int rotate, Imm8 imm8) = 0; + virtual void CMN_reg(Cond cond, Register Rn, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void CMN_rsr(Cond cond, Register Rn, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void CMP_imm(Cond cond, Register Rn, int rotate, Imm8 imm8) = 0; + virtual void CMP_reg(Cond cond, Register Rn, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void CMP_rsr(Cond cond, Register Rn, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void EOR_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void EOR_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void EOR_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void MOV_imm(Cond cond, bool S, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void MOV_reg(Cond cond, bool S, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void MOV_rsr(Cond cond, bool S, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void MVN_imm(Cond cond, bool S, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void MVN_reg(Cond cond, bool S, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void MVN_rsr(Cond cond, bool S, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void ORR_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void ORR_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void ORR_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void RSB_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void RSB_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void RSB_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void RSC_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void RSC_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void RSC_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void SBC_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void SBC_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void SBC_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void SUB_imm(Cond cond, bool S, Register Rn, Register Rd, int rotate, Imm8 imm8) = 0; + virtual void SUB_reg(Cond cond, bool S, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void SUB_rsr(Cond cond, bool S, Register Rn, Register Rd, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void TEQ_imm(Cond cond, Register Rn, int rotate, Imm8 imm8) = 0; + virtual void TEQ_reg(Cond cond, Register Rn, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void TEQ_rsr(Cond cond, Register Rn, Register Rs, ShiftType shift, Register Rm) = 0; + virtual void TST_imm(Cond cond, Register Rn, int rotate, Imm8 imm8) = 0; + virtual void TST_reg(Cond cond, Register Rn, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void TST_rsr(Cond cond, Register Rn, Register Rs, ShiftType shift, Register Rm) = 0; + + // Exception generation instructions + virtual void BKPT(Cond cond, Imm12 imm12, Imm4 imm4) = 0; + virtual void SVC(Cond cond, Imm24 imm24) = 0; + virtual void UDF() = 0; + + // Extension functions + virtual void SXTAB(Cond cond, Register Rn, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void SXTAB16(Cond cond, Register Rn, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void SXTAH(Cond cond, Register Rn, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void SXTB(Cond cond, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void SXTB16(Cond cond, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void SXTH(Cond cond, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void UXTAB(Cond cond, Register Rn, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void UXTAB16(Cond cond, Register Rn, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void UXTAH(Cond cond, Register Rn, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void UXTB(Cond cond, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void UXTB16(Cond cond, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + virtual void UXTH(Cond cond, Register Rd, SignExtendRotation rotate, Register Rm) = 0; + + // Hint instructions + virtual void PLD() = 0; + virtual void SEV() = 0; + virtual void WFE() = 0; + virtual void WFI() = 0; + virtual void YIELD() = 0; + + // Load/Store instructions + virtual void LDR_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm12 imm12) = 0; + virtual void LDR_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void LDRB_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm12 imm12) = 0; + virtual void LDRB_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void LDRBT() = 0; + virtual void LDRD_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm4 imm8a, Imm4 imm8b) = 0; + virtual void LDRD_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Register Rm) = 0; + virtual void LDRH_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm4 imm8a, Imm4 imm8b) = 0; + virtual void LDRH_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Register Rm) = 0; + virtual void LDRHT() = 0; + virtual void LDRSB_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm4 imm8a, Imm4 imm8b) = 0; + virtual void LDRSB_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Register Rm) = 0; + virtual void LDRSBT() = 0; + virtual void LDRSH_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm4 imm8a, Imm4 imm8b) = 0; + virtual void LDRSH_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Register Rm) = 0; + virtual void LDRSHT() = 0; + virtual void LDRT() = 0; + virtual void STR_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm12 imm12) = 0; + virtual void STR_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void STRB_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm12 imm12) = 0; + virtual void STRB_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm5 imm5, ShiftType shift, Register Rm) = 0; + virtual void STRBT() = 0; + virtual void STRD_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm4 imm8a, Imm4 imm8b) = 0; + virtual void STRD_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Register Rm) = 0; + virtual void STRH_imm(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Imm4 imm8a, Imm4 imm8b) = 0; + virtual void STRH_reg(Cond cond, bool P, bool U, bool W, Register Rn, Register Rd, Register Rm) = 0; + virtual void STRHT() = 0; + virtual void STRT() = 0; + + // Load/Store multiple instructions + virtual void LDM(Cond cond, bool P, bool U, bool W, Register Rn, RegisterList list) = 0; + virtual void LDM_usr() = 0; + virtual void LDM_eret() = 0; + virtual void STM(Cond cond, bool P, bool U, bool W, Register Rn, RegisterList list) = 0; + virtual void STM_usr() = 0; + + // Miscellaneous instructions + virtual void CLZ(Cond cond, Register Rd, Register Rm) = 0; + virtual void NOP() = 0; + virtual void SEL(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + + // Unsigned sum of absolute difference functions + virtual void USAD8(Cond cond, Register Rd, Register Rm, Register Rn) = 0; + virtual void USADA8(Cond cond, Register Rd, Register Ra, Register Rm, Register Rn) = 0; + + // Packing instructions + virtual void PKHBT(Cond cond, Register Rn, Register Rd, Imm5 imm5, Register Rm) = 0; + virtual void PKHTB(Cond cond, Register Rn, Register Rd, Imm5 imm5, Register Rm) = 0; + + // Reversal instructions + virtual void REV(Cond cond, Register Rd, Register Rm) = 0; + virtual void REV16(Cond cond, Register Rd, Register Rm) = 0; + virtual void REVSH(Cond cond, Register Rd, Register Rm) = 0; + + // Saturation instructions + virtual void SSAT(Cond cond, Imm5 sat_imm, Register Rd, Imm5 imm5, bool sh, Register Rn) = 0; + virtual void SSAT16(Cond cond, Imm4 sat_imm, Register Rd, Register Rn) = 0; + virtual void USAT(Cond cond, Imm5 sat_imm, Register Rd, Imm5 imm5, bool sh, Register Rn) = 0; + virtual void USAT16(Cond cond, Imm4 sat_imm, Register Rd, Register Rn) = 0; + + // Multiply (Normal) instructions + virtual void MLA(Cond cond, bool S, Register Rd, Register Ra, Register Rm, Register Rn) = 0; + virtual void MUL(Cond cond, bool S, Register Rd, Register Rm, Register Rn) = 0; + + // Multiply (Long) instructions + virtual void SMLAL(Cond cond, bool S, Register RdHi, Register RdLo, Register Rm, Register Rn) = 0; + virtual void SMULL(Cond cond, bool S, Register RdHi, Register RdLo, Register Rm, Register Rn) = 0; + virtual void UMAAL(Cond cond, Register RdHi, Register RdLo, Register Rm, Register Rn) = 0; + virtual void UMLAL(Cond cond, bool S, Register RdHi, Register RdLo, Register Rm, Register Rn) = 0; + virtual void UMULL(Cond cond, bool S, Register RdHi, Register RdLo, Register Rm, Register Rn) = 0; + + // Multiply (Halfword) instructions + virtual void SMLALxy(Cond cond, Register RdHi, Register RdLo, Register Rm, bool M, bool N, Register Rn) = 0; + virtual void SMLAxy(Cond cond, Register Rd, Register Ra, Register Rm, bool M, bool N, Register Rn) = 0; + virtual void SMULxy(Cond cond, Register Rd, Register Rm, bool M, bool N, Register Rn) = 0; + + // Multiply (word by halfword) instructions + virtual void SMLAWy(Cond cond, Register Rd, Register Ra, Register Rm, bool M, Register Rn) = 0; + virtual void SMULWy(Cond cond, Register Rd, Register Rm, bool M, Register Rn) = 0; + + // Multiply (Most significant word) instructions + virtual void SMMLA(Cond cond, Register Rd, Register Ra, Register Rm, bool R, Register Rn) = 0; + virtual void SMMLS(Cond cond, Register Rd, Register Ra, Register Rm, bool R, Register Rn) = 0; + virtual void SMMUL(Cond cond, Register Rd, Register Rm, bool R, Register Rn) = 0; + + // Multiply (Dual) instructions + virtual void SMLAD(Cond cond, Register Rd, Register Ra, Register Rm, bool M, Register Rn) = 0; + virtual void SMLALD(Cond cond, Register RdHi, Register RdLo, Register Rm, bool M, Register Rn) = 0; + virtual void SMLSD(Cond cond, Register Rd, Register Ra, Register Rm, bool M, Register Rn) = 0; + virtual void SMLSLD(Cond cond, Register RdHi, Register RdLo, Register Rm, bool M, Register Rn) = 0; + virtual void SMUAD(Cond cond, Register Rd, Register Rm, bool M, Register Rn) = 0; + virtual void SMUSD(Cond cond, Register Rd, Register Rm, bool M, Register Rn) = 0; + + // Parallel Add/Subtract (Modulo arithmetic) instructions + virtual void SADD8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SADD16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SASX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SSAX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SSUB8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SSUB16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UADD8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UADD16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UASX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void USAX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void USUB8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void USUB16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + + // Parallel Add/Subtract (Saturating) instructions + virtual void QADD8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QADD16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QASX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QSAX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QSUB8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QSUB16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UQADD8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UQADD16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UQASX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UQSAX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UQSUB8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UQSUB16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + + // Parallel Add/Subtract (Halving) instructions + virtual void SHADD8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SHADD16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SHASX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SHSAX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SHSUB8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SHSUB16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UHADD8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UHADD16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UHASX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UHSAX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UHSUB8(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void UHSUB16(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + + // Saturated Add/Subtract instructions + virtual void QADD(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QSUB(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QDADD(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void QDSUB(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + + // Synchronization Primitive instructions + virtual void CLREX() = 0; + virtual void LDREX(Cond cond, Register Rn, Register Rd) = 0; + virtual void LDREXB(Cond cond, Register Rn, Register Rd) = 0; + virtual void LDREXD(Cond cond, Register Rn, Register Rd) = 0; + virtual void LDREXH(Cond cond, Register Rn, Register Rd) = 0; + virtual void STREX(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void STREXB(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void STREXD(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void STREXH(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SWP(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + virtual void SWPB(Cond cond, Register Rn, Register Rd, Register Rm) = 0; + + // Status register access instructions + virtual void CPS() = 0; + virtual void MRS() = 0; + virtual void MSR() = 0; + virtual void RFE() = 0; + virtual void SETEND(bool E) = 0; + virtual void SRS() = 0; + + // Thumb specific instructions + virtual void thumb_B(Cond cond, Imm8 imm8) = 0; + virtual void thumb_B(Imm11 imm11) = 0; + virtual void thumb_BLX_prefix(Imm11 imm11) = 0; + virtual void thumb_BLX_suffix(bool X, Imm11 imm11) = 0; +}; + +} // namespace ArmDecoder diff --git a/src/core/arm/decoder/thumb.cpp b/src/core/arm/decoder/thumb.cpp new file mode 100644 index 000000000..3d40afa70 --- /dev/null +++ b/src/core/arm/decoder/thumb.cpp @@ -0,0 +1,438 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include + +#include + +#include "common/assert.h" +#include "common/bit_util.h" +#include "common/common_types.h" + +#include "core/arm/decoder/decoder.h" + +namespace ArmDecoder { + +ThumbMatcher MakeMatcher(const char* const str, std::function fn) { + ASSERT(strlen(str) == 16); + + u16 mask = 0; + u16 expect = 0; + + for (size_t i = 0; i < 16; i++) { + const size_t bit_position = 15 - i; + const u16 bit = 1 << bit_position; + + switch (str[i]) { + case '0': + mask |= bit; + break; + case '1': + mask |= bit; + expect |= bit; + break; + default: + break; + } + } + + return { mask, expect, fn }; +} + +using BitUtil::Bit; +using BitUtil::Bits; + +static const std::array thumb_instruction_table = { { + { "LSL/LSR/ASR", MakeMatcher("000ooxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + u32 opcode = Bits<11, 12>(instruction); + u32 imm5 = Bits<6, 10>(instruction); + Register Rm = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + switch (opcode) { + case 0: // LSL , , # + v->MOV_reg(Cond::AL, /*S=*/true, Rd, imm5, ShiftType::LSL, Rm); + break; + case 1: // LSR , , # + v->MOV_reg(Cond::AL, /*S=*/true, Rd, imm5, ShiftType::LSR, Rm); + break; + case 2: // ASR , , # + v->MOV_reg(Cond::AL, /*S=*/true, Rd, imm5, ShiftType::ASR, Rm); + break; + default: + UNREACHABLE(); + } + })}, + { "ADD/SUB_reg", MakeMatcher("000110oxxxxxxxxx", [](Visitor* v, u16 instruction) { + u32 opcode = Bit<9>(instruction); + Register Rm = static_cast(Bits<6, 8>(instruction)); + Register Rn = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + switch (opcode) { + case 0: // ADD , , + v->ADD_reg(Cond::AL, /*S=*/true, Rn, Rd, 0, ShiftType::LSL, Rm); + break; + case 1: // SUB , , + v->SUB_reg(Cond::AL, /*S=*/true, Rn, Rd, 0, ShiftType::LSL, Rm); + break; + default: + UNREACHABLE(); + } + })}, + { "ADD/SUB_imm", MakeMatcher("000111oxxxxxxxxx", [](Visitor* v, u16 instruction) { + u32 opcode = Bit<9>(instruction); + u32 imm3 = Bits<6, 8>(instruction); + Register Rn = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + switch (opcode) { + case 0: // ADD , , # + v->ADD_imm(Cond::AL, /*S=*/true, Rn, Rd, 0, imm3); + break; + case 1: // SUB , , # + v->SUB_imm(Cond::AL, /*S=*/true, Rn, Rd, 0, imm3); + break; + default: + UNREACHABLE(); + } + })}, + { "add/sub/cmp/mov_imm", MakeMatcher("001ooxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + u32 opcode = Bits<11, 12>(instruction); + Register Rd = static_cast(Bits<8, 10>(instruction)); + u32 imm8 = Bits<0, 7>(instruction); + switch (opcode) { + case 0: // MOV Rd, #imm8 + v->MOV_imm(Cond::AL, /*S=*/true, Rd, 0, imm8); + break; + case 1: // CMP Rn, #imm8 + v->CMP_imm(Cond::AL, Rd, 0, imm8); + break; + case 2: // ADD Rd, #imm8 + v->ADD_imm(Cond::AL, /*S=*/true, Rd, Rd, 0, imm8); + break; + case 3: // SUB Rd, #imm8 + v->SUB_imm(Cond::AL, /*S=*/true, Rd, Rd, 0, imm8); + break; + default: + UNREACHABLE(); + } + })}, + { "data processing reg", MakeMatcher("010000ooooxxxxxx", [](Visitor* v, u16 instruction) { + u32 opcode = Bits<6, 9>(instruction); + Register Ra = static_cast(Bits<3, 5>(instruction)); + Register Rb = static_cast(Bits<0, 2>(instruction)); + switch (opcode) { + case 0: // AND Rd, Rm + v->AND_reg(Cond::AL, /*S=*/true, Rb, Rb, 0, ShiftType::LSL, Ra); + break; + case 1: // EOR Rd, Rm + v->EOR_reg(Cond::AL, /*S=*/true, Rb, Rb, 0, ShiftType::LSL, Ra); + break; + case 2: // LSL Rd, Rs + v->MOV_rsr(Cond::AL, /*S=*/true, Rb, Ra, ShiftType::LSL, Rb); + break; + case 3: // LSR Rd, Rs + v->MOV_rsr(Cond::AL, /*S=*/true, Rb, Ra, ShiftType::LSR, Rb); + break; + case 4: // ASR Rd, Rs + v->MOV_rsr(Cond::AL, /*S=*/true, Rb, Ra, ShiftType::ASR, Rb); + break; + case 5: // ADC Rd, Rm + v->ADC_reg(Cond::AL, /*S=*/true, Rb, Rb, 0, ShiftType::LSL, Ra); + break; + case 6: // SBC Rd, Rm + v->SBC_reg(Cond::AL, /*S=*/true, Rb, Rb, 0, ShiftType::LSL, Ra); + break; + case 7: // ROR Rd, Rs + v->MOV_rsr(Cond::AL, /*S=*/true, Rb, Ra, ShiftType::ROR, Rb); + break; + case 8: // TST Rm, Rn + v->TST_reg(Cond::AL, Rb, 0, ShiftType::LSL, Ra); + break; + case 9: // NEG Rd, Rm + v->RSB_imm(Cond::AL, /*S=*/true, Ra, Rb, 0, 0); + break; + case 10: // CMP Rm, Rn + v->CMP_reg(Cond::AL, Rb, 0, ShiftType::LSL, Ra); + break; + case 11: // CMN Rm, Rn + v->CMN_reg(Cond::AL, Rb, 0, ShiftType::LSL, Ra); + break; + case 12: // ORR Rd, Rm + v->ORR_reg(Cond::AL, /*S=*/true, Rb, Rb, 0, ShiftType::LSL, Ra); + break; + case 13: // MUL Rd, Rm + v->MUL(Cond::AL, /*S=*/true, Rb, Rb, Ra); + break; + case 14: // BIC Rm, Rd + v->BIC_reg(Cond::AL, /*S=*/true, Rb, Rb, 0, ShiftType::LSL, Ra); + break; + case 15: // MVN Rd, Rm + v->MVN_reg(Cond::AL, /*S=*/true, Rb, 0, ShiftType::LSL, Ra); + break; + default: + UNREACHABLE(); + } + })}, + { "special data processing", MakeMatcher("010001ooxxxxxxxx", [](Visitor* v, u16 instruction) { + u32 opcode = Bits<8, 9>(instruction); + Register Rm = static_cast(Bits<3, 6>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction) | (Bit<7>(instruction) << 3)); + switch (opcode) { + case 0: // ADD Rd, Rm + v->ADD_reg(Cond::AL, /*S=*/false, Rd, Rd, 0, ShiftType::LSL, Rm); + break; + case 1: // CMP Rm, Rn + v->CMP_reg(Cond::AL, Rd, 0, ShiftType::LSL, Rm); + break; + case 2: // MOV Rd, Rm + v->MOV_reg(Cond::AL, /*S=*/false, Rd, 0, ShiftType::LSL, Rm); + break; + default: + UNREACHABLE(); + } + })}, + { "BLX/BX", MakeMatcher("01000111xxxxx000", [](Visitor* v, u16 instruction) { + bool L = Bit<7>(instruction); + Register Rm = static_cast(Bits<3, 6>(instruction)); + if (!L) { // BX Rm + v->BX(Cond::AL, Rm); + } else { // BLX Rm + v->BLX_reg(Cond::AL, Rm); + } + })}, + { "load from literal pool", MakeMatcher("01001xxxxxxxxxxx", [](Visitor* v, u16 instruction) { + // LDR Rd, [PC, #] + Register Rd = static_cast(Bits<8, 10>(instruction)); + u32 imm8 = Bits<0, 7>(instruction); + v->LDR_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Register::PC, Rd, imm8 * 4); + })}, + { "load/store reg offset", MakeMatcher("0101oooxxxxxxxxx", [](Visitor* v, u16 instruction) { + u32 opcode = Bits<9, 11>(instruction); + Register Rm = static_cast(Bits<6, 8>(instruction)); + Register Rn = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + switch (opcode) { + case 0: // STR Rd, [Rn, Rm] + v->STR_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, 0, ShiftType::LSL, Rm); + break; + case 1: // STRH Rd, [Rn, Rm] + v->STRH_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, Rm); + break; + case 2: // STRB Rd, [Rn, Rm] + v->STRB_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, 0, ShiftType::LSL, Rm); + break; + case 3: // LDRSB Rd, [Rn, Rm] + v->LDRSB_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, Rm); + break; + case 4: // LDR Rd, [Rn, Rm] + v->LDR_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, 0, ShiftType::LSL, Rm); + break; + case 5: // LDRH Rd, [Rn, Rm] + v->LDRH_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, Rm); + break; + case 6: // LDRB Rd, [Rn, Rm] + v->LDRB_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, 0, ShiftType::LSL, Rm); + break; + case 7: // LDRSH Rd, [Rn, Rm] + v->LDRSH_reg(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, Rm); + break; + default: + UNREACHABLE(); + } + })}, + { "STR(B)/LDR(B)_imm", MakeMatcher("011xxxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + u32 opc = Bits<11, 12>(instruction); + u32 offset = Bits<6, 10>(instruction); + Register Rn = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + switch (opc) { + case 0: // STR Rd, [Rn, #offset] + v->STR_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, offset * 4); + break; + case 1: // LDR Rd, [Rn, #offset] + v->LDR_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, offset * 4); + break; + case 2: // STRB Rd, [Rn, #offset] + v->STRB_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, offset); + break; + case 3: // LDRB Rd, [Rn, #offset] + v->LDRB_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, offset); + break; + default: + UNREACHABLE(); + } + })}, + { "STRH/LDRH_imm", MakeMatcher("1000xxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + bool L = Bit<11>(instruction); + u32 offset = Bits<6, 10>(instruction); + Register Rn = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + if (!L) { // STRH Rd, [Rn, #offset] + v->STRH_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, (offset * 2) >> 4, (offset * 2) & 0xF); + } else { // LDRH Rd, [Rn, #offset] + v->LDRH_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Rn, Rd, (offset * 2) >> 4, (offset * 2) & 0xF); + } + })}, + { "load/store stack", MakeMatcher("1001xxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + bool L = Bit<11>(instruction); + Register Rd = static_cast(Bits<8, 10>(instruction)); + u32 offset = Bits<0, 7>(instruction); + if (!L) { // STR Rd, [SP, #offset] + v->STR_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Register::SP, Rd, offset * 4); + } else { // LDR Rd, [SP, #offset] + v->LDR_imm(Cond::AL, /*P=*/1, /*U=*/1, /*W=*/0, Register::SP, Rd, offset * 4); + } + })}, + { "add to sp/pc", MakeMatcher("1010oxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + // ADD Rd, PC/SP, #imm8 + Register Rn = Bit<11>(instruction) ? Register::SP : Register::PC; + Register Rd = static_cast(Bits<8, 10>(instruction)); + u32 imm8 = Bits<0, 7>(instruction); + v->ADD_imm(Cond::AL, /*S=*/false, Rn, Rd, 0xF, imm8); + })}, + { "adjust stack ptr", MakeMatcher("10110000oxxxxxxx", [](Visitor* v, u16 instruction) { + // SUB SP, SP, # + u32 opc = Bit<7>(instruction); + u32 imm7 = Bits<0, 6>(instruction); + switch (opc) { + case 0: + v->ADD_imm(Cond::AL, /*S=*/false, Register::SP, Register::SP, 0xF, imm7); + break; + case 1: + v->SUB_imm(Cond::AL, /*S=*/false, Register::SP, Register::SP, 0xF, imm7); + break; + default: + UNREACHABLE(); + } + })}, + { "sign/zero extend", MakeMatcher("10110010ooxxxxxx", [](Visitor* v, u16 instruction) { + u32 opc = Bits<6, 7>(instruction); + Register Rm = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + switch (opc) { + case 0: // SXTH Rd, Rm + v->SXTH(Cond::AL, Rd, SignExtendRotation::ROR_0, Rm); + break; + case 1: // SXTB Rd, Rm + v->SXTB(Cond::AL, Rd, SignExtendRotation::ROR_0, Rm); + break; + case 2: // UXTH Rd, Rm + v->UXTH(Cond::AL, Rd, SignExtendRotation::ROR_0, Rm); + break; + case 3: // UXTB Rd, Rm + v->UXTB(Cond::AL, Rd, SignExtendRotation::ROR_0, Rm); + break; + default: + UNREACHABLE(); + } + })}, + { "PUSH/POP_reglist", MakeMatcher("1011x10xxxxxxxxx", [](Visitor* v, u16 instruction) { + bool L = Bit<11>(instruction); + u32 R = Bit<8>(instruction); + u32 reglist = Bits<0, 7>(instruction); + if (!L) { // PUSH {reglist, =LR} + reglist |= R << 14; + // Equivalent to STMDB SP!, {reglist} + v->STM(Cond::AL, /*P=*/1, /*U=*/0, /*W=*/1, Register::SP, reglist); + } else { // POP {reglist, =PC} + reglist |= R << 15; + // Equivalent to LDMIA SP!, {reglist} + v->LDM(Cond::AL, /*P=*/0, /*U=*/1, /*W=*/1, Register::SP, reglist); + } + })}, + { "SETEND", MakeMatcher("101101100101x000", [](Visitor* v, u16 instruction) { + u16 E = Bit<3>(instruction); + v->SETEND(E); + })}, + { "change processor state", MakeMatcher("10110110011x0xxx", [](Visitor* v, u16 instruction) { + u16 imod = Bit<4>(instruction); + u16 A = Bit<2>(instruction); + u16 I = Bit<1>(instruction); + u16 F = Bit<0>(instruction); + v->CPS(); + })}, + { "reverse bytes", MakeMatcher("10111010ooxxxxxx", [](Visitor* v, u16 instruction) { + u32 opc = Bits<6, 7>(instruction); + Register Rn = static_cast(Bits<3, 5>(instruction)); + Register Rd = static_cast(Bits<0, 2>(instruction)); + switch (opc) { + case 0: // REV Rd, Rn + v->REV(Cond::AL, Rd, Rn); + break; + case 1: // REV16 Rd, Rn + v->REV16(Cond::AL, Rd, Rn); + break; + case 2: // undefined + v->UDF(); + break; + case 3: // REVSH Rd, Rn + v->REVSH(Cond::AL, Rd, Rn); + break; + default: + UNREACHABLE(); + } + })}, + { "BKPT", MakeMatcher("10111110xxxxxxxx", [](Visitor* v, u16 instruction) { + // BKPT #imm8 + Imm8 imm8 = Bits<0, 7>(instruction); + v->BKPT(Cond::AL, imm8 >> 4, imm8 & 0xF); + })}, + { "STMIA/LDMIA", MakeMatcher("1100xxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + bool L = Bit<11>(instruction); + Register Rn = static_cast(Bits<8, 10>(instruction)); + u32 reglist = Bits<0, 7>(instruction); + if (!L) { // STMIA Rn!, { reglist } + v->STM(Cond::AL, /*P=*/0, /*U=*/1, /*W=*/1, Rn, reglist); + } else { // LDMIA Rn!, { reglist } + RegisterList Rn_bit = 1 << static_cast(Rn); + bool w = (reglist & Rn_bit) == 0; + v->LDM(Cond::AL, /*P=*/0, /*U=*/1, /*W=*/w, Rn, reglist); + } + })}, + { "B", MakeMatcher("1101xxxxxxxxxxxx", [](Visitor* v, u16 instruction) { + // B + Cond cond = static_cast(Bits<8, 11>(instruction)); + s32 offset = Bits<0, 7>(instruction); + ASSERT_MSG(cond != Cond::AL, "UNDEFINED"); + v->thumb_B(cond, offset); + })}, + { "SWI", MakeMatcher("11011111xxxxxxxx", [](Visitor* v, u16 instruction) { + // SWI #imm8 + Imm8 imm8 = Bits<0, 7>(instruction); + v->SVC(Cond::AL, imm8); + })}, + { "B", MakeMatcher("11100xxxxxxxxxxx", [](Visitor* v, u16 instruction) { + // B + Imm11 imm11 = Bits<0, 10>(instruction); + v->thumb_B(imm11); + })}, + { "BLX (suffix)", MakeMatcher("11101xxxxxxxxxx0", [](Visitor* v, u16 instruction) { + Imm11 imm11 = Bits<0, 10>(instruction); + v->thumb_BLX_suffix(/*X=*/true, imm11); + })}, + { "BL/BLX (prefix)", MakeMatcher("11110xxxxxxxxxxx", [](Visitor* v, u16 instruction) { + Imm11 imm11 = Bits<0, 10>(instruction); + v->thumb_BLX_prefix(imm11); + })}, + { "BL (suffix)", MakeMatcher("11111xxxxxxxxxxx", [](Visitor* v, u16 instruction) { + Imm11 imm11 = Bits<0, 10>(instruction); + v->thumb_BLX_suffix(/*X=*/false, imm11); + })} +}}; + +boost::optional DecodeThumb(u16 i) { + // NOTE: The reverse search direction is important. Searching forwards would result in incorrect behavior. + // This is because the entries in thumb_instruction_table have more specific matches coming after less specific ones. + // Example: + // 000ooxxxxxxxxxxx comes before 000110oxxxxxxxxx + // with a forward search direction notice how the first one will always be matched and the latter never will be. + auto iterator = std::find_if(thumb_instruction_table.crbegin(), thumb_instruction_table.crend(), + [i](const auto& instruction) { return instruction.Match(i); }); + + return (iterator != thumb_instruction_table.crend()) ? boost::make_optional(*iterator) : boost::none; +} + +}; diff --git a/src/core/arm/disassembler/arm_disasm.cpp b/src/core/arm/disassembler/arm_disasm.cpp index 5ad1f1c29..cf3bc12e1 100644 --- a/src/core/arm/disassembler/arm_disasm.cpp +++ b/src/core/arm/disassembler/arm_disasm.cpp @@ -3,6 +3,8 @@ #include #include +#include "common/assert.h" +#include "common/bit_util.h" #include "common/common_types.h" #include "common/string_util.h" @@ -252,8 +254,7 @@ std::string ARM_Disasm::Disassemble(u32 addr, u32 insn) case OP_BKPT: return DisassembleBKPT(insn); case OP_BLX: - // not supported yet - break; + return DisassembleBLX(insn); case OP_BX: return DisassembleBX(insn); case OP_CDP: @@ -513,6 +514,21 @@ std::string ARM_Disasm::DisassembleBX(u32 insn) return Common::StringFromFormat("bx%s\tr%d", cond_to_str(cond), rn); } +std::string ARM_Disasm::DisassembleBLX(u32 insn) +{ + if ((insn & 0xFE000000) == 0xFA000000) { + u32 imm24 = insn & 0xFFFFFF; + u32 H = (insn >> 24) & 1; + s32 offset = BitUtil::SignExtend<26>((imm24 << 2) + (H << 1)) + 8; + return Common::StringFromFormat("blx\t#+%d", offset); + } else if ((insn & 0x0FFFFFF0) == 0x012FFF30) { + u8 cond = (insn >> 28) & 0xf; + u8 rn = insn & 0xf; + return Common::StringFromFormat("blx%s\tr%d", cond_to_str(cond), rn); + } + UNREACHABLE(); +} + std::string ARM_Disasm::DisassembleBKPT(u32 insn) { u8 cond = (insn >> 28) & 0xf; @@ -1062,6 +1078,10 @@ Opcode ARM_Disasm::Decode00(u32 insn) { // Bx instruction return OP_BX; } + if ((insn & 0x0ffffff0) == 0x012fff30) { + // Blx instruction + return OP_BLX; + } if ((insn & 0x0ff000f0) == 0x01600010) { // Clz instruction return OP_CLZ; diff --git a/src/core/arm/disassembler/arm_disasm.h b/src/core/arm/disassembler/arm_disasm.h index 53d9c6a74..ddd21de7e 100644 --- a/src/core/arm/disassembler/arm_disasm.h +++ b/src/core/arm/disassembler/arm_disasm.h @@ -213,6 +213,7 @@ class ARM_Disasm { static std::string DisassembleALU(Opcode opcode, u32 insn); static std::string DisassembleBranch(u32 addr, Opcode opcode, u32 insn); static std::string DisassembleBX(u32 insn); + static std::string DisassembleBLX(u32 insn); static std::string DisassembleBKPT(u32 insn); static std::string DisassembleCLZ(u32 insn); static std::string DisassembleMediaMulDiv(Opcode opcode, u32 insn); diff --git a/src/core/arm/dyncom/arm_dyncom.cpp b/src/core/arm/dyncom/arm_dyncom.cpp index a3581132c..12a6f325c 100644 --- a/src/core/arm/dyncom/arm_dyncom.cpp +++ b/src/core/arm/dyncom/arm_dyncom.cpp @@ -18,6 +18,7 @@ ARM_DynCom::ARM_DynCom(PrivilegeMode initial_mode) { state = std::make_unique(initial_mode); + ClearCache(); } ARM_DynCom::~ARM_DynCom() { @@ -125,3 +126,8 @@ void ARM_DynCom::LoadContext(const Core::ThreadContext& ctx) { void ARM_DynCom::PrepareReschedule() { state->NumInstrsToExecute = 0; } + +void ARM_DynCom::ClearCache() { + state->instruction_cache.clear(); + InterpreterClearCache(); +} diff --git a/src/core/arm/dyncom/arm_dyncom.h b/src/core/arm/dyncom/arm_dyncom.h index 3664fd728..c4a66202d 100644 --- a/src/core/arm/dyncom/arm_dyncom.h +++ b/src/core/arm/dyncom/arm_dyncom.h @@ -43,6 +43,8 @@ public: void PrepareReschedule() override; void ExecuteInstructions(int num_instructions) override; + void ClearCache() override; + private: std::unique_ptr state; }; diff --git a/src/core/arm/dyncom/arm_dyncom_interpreter.cpp b/src/core/arm/dyncom/arm_dyncom_interpreter.cpp index 647784208..e83714d81 100644 --- a/src/core/arm/dyncom/arm_dyncom_interpreter.cpp +++ b/src/core/arm/dyncom/arm_dyncom_interpreter.cpp @@ -1144,6 +1144,10 @@ static inline void *AllocBuffer(unsigned int size) { return (void *)&inst_buf[start]; } +void InterpreterClearCache() { + top = 0; +} + static shtop_fp_t get_shtop(unsigned int inst) { if (BIT(inst, 25)) { return DPO(Immediate); @@ -3884,6 +3888,9 @@ unsigned InterpreterMainLoop(ARMul_State* cpu) { LOAD_NZCVT; DISPATCH: { + if (num_instrs >= cpu->NumInstrsToExecute) + goto END; + if (!cpu->NirqSig) { if (!(cpu->Cpsr & 0x80)) { goto END; diff --git a/src/core/arm/dyncom/arm_dyncom_interpreter.h b/src/core/arm/dyncom/arm_dyncom_interpreter.h index 7a46dcc94..5d5b2d52b 100644 --- a/src/core/arm/dyncom/arm_dyncom_interpreter.h +++ b/src/core/arm/dyncom/arm_dyncom_interpreter.h @@ -7,3 +7,4 @@ struct ARMul_State; unsigned InterpreterMainLoop(ARMul_State* state); +void InterpreterClearCache(); diff --git a/src/core/arm/jit_x64/common.h b/src/core/arm/jit_x64/common.h new file mode 100644 index 000000000..97507dec9 --- /dev/null +++ b/src/core/arm/jit_x64/common.h @@ -0,0 +1,56 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include "common/common_types.h" + +#include "core/arm/decoder/decoder.h" +#include "core/arm/skyeye_common/armstate.h" + +namespace JitX64 { + +using ArmReg = ArmDecoder::Register; +using ArmRegList = ArmDecoder::RegisterList; +using ArmImm4 = ArmDecoder::Imm4; +using ArmImm5 = ArmDecoder::Imm5; +using ArmImm8 = ArmDecoder::Imm8; +using ArmImm11 = ArmDecoder::Imm11; +using ArmImm12 = ArmDecoder::Imm12; +using ArmImm24 = ArmDecoder::Imm24; +using Cond = ArmDecoder::Cond; +using ShiftType = ArmDecoder::ShiftType; +using SignExtendRotation = ArmDecoder::SignExtendRotation; + +struct JitState final { + JitState() : cpu_state(PrivilegeMode::USER32MODE) {} + void Reset() { + cpu_state.Reset(); + } + + ARMul_State cpu_state; + + /// This value should always be appropriately aligned for a CALL instruction to be made. + u64 save_host_RSP = 0; + /// Jitted code will JMP to this value when done. Should contain the an address which returns to the dispatcher. + u64 return_RIP = 0; + /// If this value becomes <= 0, jitted code will jump to return_RIP. + s32 cycles_remaining = 0; +}; + +constexpr bool IsValidArmReg(ArmReg arm_reg) { + return static_cast(arm_reg) <= 15; +} + +inline bool IsEvenArmReg(ArmReg arm_reg) { + ASSERT(IsValidArmReg(arm_reg)); + return static_cast(arm_reg) % 2 == 0; +} + +/// Turns a ArmReg into an ArmRegList bitmap. +constexpr ArmRegList MakeRegList(ArmReg arm_reg) { + return 1 << static_cast(arm_reg); +} + +} diff --git a/src/core/arm/jit_x64/cond.cpp b/src/core/arm/jit_x64/cond.cpp new file mode 100644 index 000000000..18ffbc417 --- /dev/null +++ b/src/core/arm/jit_x64/cond.cpp @@ -0,0 +1,146 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/assert.h" + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +using namespace Gen; + +void JitX64::CondManager::Init(JitX64* jit_) { + jit = jit_; + current_cond = Cond::AL; + flags_dirty = false; + current_cond_fixup = {}; +} + +void JitX64::CondManager::CompileCond(const Cond new_cond) { + if (current_cond == new_cond && !flags_dirty) + return; + + if (current_cond != Cond::AL && current_cond != Cond::NV) { + jit->reg_alloc.FlushEverything(); + jit->reg_alloc.AssertNoLocked(); + ASSERT(current_cond_fixup.ptr); + jit->code->SetJumpTarget(current_cond_fixup); + current_cond_fixup.ptr = nullptr; + } + + if (new_cond != Cond::AL && new_cond != Cond::NV) { + CCFlags cc; + + switch (new_cond) { + case Cond::EQ: //z + jit->code->CMP(8, jit->MJitStateZFlag(), Imm8(0)); + cc = CC_E; + break; + case Cond::NE: //!z + jit->code->CMP(8, jit->MJitStateZFlag(), Imm8(0)); + cc = CC_NE; + break; + case Cond::CS: //c + jit->code->CMP(8, jit->MJitStateCFlag(), Imm8(0)); + cc = CC_E; + break; + case Cond::CC: //!c + jit->code->CMP(8, jit->MJitStateCFlag(), Imm8(0)); + cc = CC_NE; + break; + case Cond::MI: //n + jit->code->CMP(8, jit->MJitStateNFlag(), Imm8(0)); + cc = CC_E; + break; + case Cond::PL: //!n + jit->code->CMP(8, jit->MJitStateNFlag(), Imm8(0)); + cc = CC_NE; + break; + case Cond::VS: //v + jit->code->CMP(8, jit->MJitStateVFlag(), Imm8(0)); + cc = CC_E; + break; + case Cond::VC: //!v + jit->code->CMP(8, jit->MJitStateVFlag(), Imm8(0)); + cc = CC_NE; + break; + case Cond::HI: { //c & !z + const X64Reg tmp = jit->reg_alloc.AllocTemp(); + jit->code->MOVZX(64, 8, tmp, jit->MJitStateZFlag()); + jit->code->CMP(8, jit->MJitStateCFlag(), R(tmp)); + cc = CC_BE; + jit->reg_alloc.UnlockTemp(tmp); + break; + } + case Cond::LS: { //!c | z + const X64Reg tmp = jit->reg_alloc.AllocTemp(); + jit->code->MOVZX(64, 8, tmp, jit->MJitStateZFlag()); + jit->code->CMP(8, jit->MJitStateCFlag(), R(tmp)); + cc = CC_A; + jit->reg_alloc.UnlockTemp(tmp); + break; + } + case Cond::GE: { // n == v + const X64Reg tmp = jit->reg_alloc.AllocTemp(); + jit->code->MOVZX(64, 8, tmp, jit->MJitStateVFlag()); + jit->code->CMP(8, jit->MJitStateNFlag(), R(tmp)); + cc = CC_NE; + jit->reg_alloc.UnlockTemp(tmp); + break; + } + case Cond::LT: { // n != v + const X64Reg tmp = jit->reg_alloc.AllocTemp(); + jit->code->MOVZX(64, 8, tmp, jit->MJitStateVFlag()); + jit->code->CMP(8, jit->MJitStateNFlag(), R(tmp)); + cc = CC_E; + jit->reg_alloc.UnlockTemp(tmp); + break; + } + case Cond::GT: { // !z & (n == v) + const X64Reg tmp = jit->reg_alloc.AllocTemp(); + jit->code->MOVZX(64, 8, tmp, jit->MJitStateNFlag()); + jit->code->XOR(8, R(tmp), jit->MJitStateVFlag()); + jit->code->OR(8, R(tmp), jit->MJitStateZFlag()); + jit->code->TEST(8, R(tmp), R(tmp)); + cc = CC_NZ; + jit->reg_alloc.UnlockTemp(tmp); + break; + } + case Cond::LE: { // z | (n != v) + X64Reg tmp = jit->reg_alloc.AllocTemp(); + jit->code->MOVZX(64, 8, tmp, jit->MJitStateNFlag()); + jit->code->XOR(8, R(tmp), jit->MJitStateVFlag()); + jit->code->OR(8, R(tmp), jit->MJitStateZFlag()); + jit->code->TEST(8, R(tmp), R(tmp)); + cc = CC_Z; + jit->reg_alloc.UnlockTemp(tmp); + break; + } + default: + UNREACHABLE(); + break; + } + + jit->reg_alloc.FlushEverything(); + jit->reg_alloc.AssertNoLocked(); + this->current_cond_fixup = jit->code->J_CC(cc, true); + } + + current_cond = new_cond; + flags_dirty = false; +} + +void JitX64::CondManager::Always() { + CompileCond(Cond::AL); +} + +void JitX64::CondManager::FlagsDirty() { + flags_dirty = true; +} + +Cond JitX64::CondManager::CurrentCond() const { + return current_cond; +} + +} diff --git a/src/core/arm/jit_x64/instructions/branch.cpp b/src/core/arm/jit_x64/instructions/branch.cpp new file mode 100644 index 000000000..400d55973 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/branch.cpp @@ -0,0 +1,120 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/bit_util.h" + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +using namespace Gen; + +void JitX64::B(Cond cond, ArmImm24 imm24) { + cond_manager.CompileCond(cond); + + const u32 new_pc = GetReg15Value() + BitUtil::SignExtend<26>(imm24 << 2); + + reg_alloc.FlushEverything(); + current.arm_pc += GetInstSize(); + CompileUpdateCycles(false); + CompileJumpToBB(new_pc); + + if (cond == Cond::AL) { + stop_compilation = true; + } +} + +void JitX64::BL(Cond cond, ArmImm24 imm24) { + cond_manager.CompileCond(cond); + + const u32 new_pc = GetReg15Value() + BitUtil::SignExtend<26>(imm24 << 2); + + ASSERT(!current.TFlag); + const u32 link_pc = current.arm_pc + GetInstSize(); + Gen::OpArg LR = reg_alloc.LockArmForWrite(ArmReg::LR); + code->MOV(32, LR, Imm32(link_pc)); + reg_alloc.UnlockArm(ArmReg::LR); + + reg_alloc.FlushEverything(); + current.arm_pc += GetInstSize(); + CompileUpdateCycles(false); + CompileJumpToBB(new_pc); + + if (cond == Cond::AL) { + stop_compilation = true; + } +} + +void JitX64::BLX_imm(bool H, ArmImm24 imm24) { + cond_manager.Always(); + + const u32 new_pc = GetReg15Value() + BitUtil::SignExtend<26>(imm24 << 2) + (H ? 2 : 0); + + ASSERT(!current.TFlag); + const u32 link_pc = current.arm_pc + GetInstSize(); + Gen::OpArg LR = reg_alloc.LockArmForWrite(ArmReg::LR); + code->MOV(32, LR, Imm32(link_pc)); + reg_alloc.UnlockArm(ArmReg::LR); + + current.TFlag = true; + code->MOV(32, MJitStateTFlag(), Imm32(1)); + + reg_alloc.FlushEverything(); + current.arm_pc += GetInstSize(); + CompileUpdateCycles(false); + CompileJumpToBB(new_pc); + + stop_compilation = true; +} + +void JitX64::BLX_reg(Cond cond, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rm_index != ArmReg::PC, "UNPREDICTABLE"); + + const u32 link_pc = current.arm_pc + GetInstSize() + (current.TFlag ? 1 : 0); + Gen::OpArg LR = reg_alloc.LockArmForWrite(ArmReg::LR); + code->MOV(32, LR, Imm32(link_pc)); + reg_alloc.UnlockArm(ArmReg::LR); + + Gen::X64Reg Rm = reg_alloc.BindArmForRead(Rm_index); + code->MOV(32, MJitStateArmPC(), R(Rm)); + code->AND(32, MJitStateArmPC(), Imm32(0xFFFFFFFE)); + code->BT(32, R(Rm), Imm8(0)); + code->SETcc(CC_C, MJitStateTFlag()); // NOTE: current.TFlag is now inaccurate + reg_alloc.UnlockArm(Rm_index); + + current.arm_pc += GetInstSize(); + CompileReturnToDispatch(); + + stop_compilation = true; +} + +void JitX64::BX(Cond cond, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + if (Rm_index == ArmReg::PC) { + code->MOV(32, MJitStateArmPC(), Imm32(GetReg15Value())); + code->MOV(32, MJitStateTFlag(), Imm32(0)); + } else { + Gen::X64Reg Rm = reg_alloc.BindArmForRead(Rm_index); + code->MOV(32, MJitStateArmPC(), R(Rm)); + code->AND(32, MJitStateArmPC(), Imm32(0xFFFFFFFE)); + code->BT(32, R(Rm), Imm8(0)); + code->SETcc(CC_C, MJitStateTFlag()); // NOTE: current.TFlag is now inaccurate + reg_alloc.UnlockArm(Rm_index); + } + + current.arm_pc += GetInstSize(); + CompileReturnToDispatch(); + + stop_compilation = true; +} + +void JitX64::BXJ(Cond cond, ArmReg Rm) { + // BXJ behaves exactly as BX since Jazelle is not supported + BX(cond, Rm); +} + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/coprocessor.cpp b/src/core/arm/jit_x64/instructions/coprocessor.cpp new file mode 100644 index 000000000..c9262938e --- /dev/null +++ b/src/core/arm/jit_x64/instructions/coprocessor.cpp @@ -0,0 +1,17 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::CDP() { CompileInterpretInstruction(); } +void JitX64::LDC() { CompileInterpretInstruction(); } +void JitX64::MCR() { CompileInterpretInstruction(); } +void JitX64::MCRR() { CompileInterpretInstruction(); } +void JitX64::MRC() { CompileInterpretInstruction(); } +void JitX64::MRRC() { CompileInterpretInstruction(); } +void JitX64::STC() { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/data_processing.cpp b/src/core/arm/jit_x64/instructions/data_processing.cpp new file mode 100644 index 000000000..df6c20381 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/data_processing.cpp @@ -0,0 +1,1435 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/common_funcs.h" + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +using namespace Gen; + +void JitX64::CompileDataProcessingHelper(ArmReg Rn_index, ArmReg Rd_index, std::function body) { + if (Rn_index == ArmReg::PC) { + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + + code->MOV(32, R(Rd), Imm32(GetReg15Value())); + body(Rd); + + reg_alloc.UnlockArm(Rd_index); + } else if (Rn_index == Rd_index) { // Note: Rd_index cannot possibly be 15 in this case. + X64Reg Rd = reg_alloc.BindArmForReadWrite(Rd_index); + + body(Rd); + + reg_alloc.UnlockArm(Rd_index); + } else { + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->MOV(32, R(Rd), Rn); + reg_alloc.UnlockArm(Rn_index); + + body(Rd); + + reg_alloc.UnlockArm(Rd_index); + } +} + +void JitX64::CompileDataProcessingHelper_Reverse(ArmReg Rn_index, ArmReg Rd_index, std::function body) { + if (Rd_index != Rn_index) { + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + + body(Rd); + + reg_alloc.UnlockArm(Rd_index); + } else { + X64Reg tmp = reg_alloc.AllocTemp(); + + body(tmp); + + if (Rd_index != ArmReg::PC) { + // TODO: Efficiency: Could implement this as a register rebind instead of needing to MOV. + OpArg Rd = reg_alloc.LockArmForReadWrite(Rd_index); + code->MOV(32, Rd, R(tmp)); + reg_alloc.UnlockArm(Rd_index); + } else { + code->MOV(32, MJitStateArmPC(), R(tmp)); + } + + reg_alloc.UnlockTemp(tmp); + } +} + +void JitX64::CompileShifter_imm(X64Reg dest, ArmImm5 imm5, ShiftType shift, bool do_shifter_carry_out) { + // dest must contain a copy of the value of Rm. + // if do_shifter_carry_out, + // we output code that calculates and puts shifter_carry_out into MJitStateCFlag(). + + switch (shift) { + case ShiftType::LSL: // Logical shift left by immediate + if (imm5 != 0) { + code->SHL(32, R(dest), Imm8(imm5)); + if (do_shifter_carry_out) { + code->SETcc(CC_C, MJitStateCFlag()); + } + } + return; + case ShiftType::LSR: // Logical shift right by immediate + if (imm5 == 0) { + if (do_shifter_carry_out) { + code->BT(32, R(dest), Imm8(31)); + code->SETcc(CC_C, MJitStateCFlag()); + } + code->MOV(64, R(dest), Imm32(0)); + } else { + code->SHR(32, R(dest), Imm8(imm5)); + if (do_shifter_carry_out) { + code->SETcc(CC_C, MJitStateCFlag()); + } + } + return; + case ShiftType::ASR: // Arithmetic shift right by immediate + if (imm5 == 0) { + if (do_shifter_carry_out) { + code->BT(32, R(dest), Imm8(31)); + code->SETcc(CC_C, MJitStateCFlag()); + } + code->SAR(32, R(dest), Imm8(31)); + } else { + code->SAR(32, R(dest), Imm8(imm5)); + if (do_shifter_carry_out) { + code->SETcc(CC_C, MJitStateCFlag()); + } + } + return; + case ShiftType::ROR: // Rotate right by immediate + if (imm5 == 0) { //RRX + code->BT(8, MJitStateCFlag(), Imm8(0)); + code->RCR(32, R(dest), Imm8(1)); + if (do_shifter_carry_out) { + code->SETcc(CC_C, MJitStateCFlag()); + } + } else { + code->ROR(32, R(dest), Imm8(imm5)); + if (do_shifter_carry_out) { + code->SETcc(CC_C, MJitStateCFlag()); + } + } + return; + } + + UNREACHABLE(); +} + +X64Reg JitX64::CompileDataProcessingHelper_reg(ArmImm5 imm5, ShiftType shift, ArmReg Rm_index, bool do_shifter_carry_out) { + X64Reg tmp = reg_alloc.AllocTemp(); + + if (Rm_index != ArmReg::PC) { + OpArg Rm = reg_alloc.LockArmForRead(Rm_index); + code->MOV(32, R(tmp), Rm); + reg_alloc.UnlockArm(Rm_index); + } else { + code->MOV(32, R(tmp), Imm32(GetReg15Value())); + } + + if (do_shifter_carry_out) { + cond_manager.FlagsDirty(); + } + + CompileShifter_imm(tmp, imm5, shift, do_shifter_carry_out); + + return tmp; +} + +X64Reg JitX64::CompileDataProcessingHelper_rsr(ArmReg Rs_index, ShiftType shift, ArmReg Rm_index, bool do_shifter_carry_out) { + // Caller must call reg_alloc.UnlockTemp on return value. + // if do_shifter_carry_out, + // we output code that calculates and puts shifter_carry_out into MJitStateCFlag(). + + reg_alloc.FlushX64(RCX); + reg_alloc.LockX64(RCX); + + X64Reg tmp = reg_alloc.AllocTemp(); + + if (Rs_index != ArmReg::PC) { + OpArg Rs = reg_alloc.LockArmForRead(Rs_index); + code->MOV(32, R(RCX), Rs); + code->AND(32, R(RCX), Imm32(0xFF)); + reg_alloc.UnlockArm(Rs_index); + } else { + code->MOV(32, R(RCX), Imm32(GetReg15Value() & 0xFF)); + } + + if (Rm_index != ArmReg::PC) { + OpArg Rm = reg_alloc.LockArmForRead(Rm_index); + code->MOV(32, R(tmp), Rm); + reg_alloc.UnlockArm(Rm_index); + } else { + code->MOV(32, R(tmp), Imm32(GetReg15Value())); + } + + switch (shift) { + case ShiftType::LSL: { // Logical shift left by register + if (!do_shifter_carry_out) { + code->SHL(32, R(tmp), R(CL)); + + code->CMP(32, R(RCX), Imm8(32)); + X64Reg zero = reg_alloc.AllocTemp(); + code->MOV(32, R(zero), Imm32(0)); + code->CMOVcc(32, tmp, R(zero), CC_NB); + reg_alloc.UnlockTemp(zero); + } else { + code->CMP(32, R(RCX), Imm8(32)); + auto Rs_gt32 = code->J_CC(CC_A); + auto Rs_eq32 = code->J_CC(CC_E); + // if (Rs & 0xFF == 0) goto end; + code->TEST(32, R(RCX), R(RCX)); + auto Rs_zero = code->J_CC(CC_Z); + // if (Rs & 0xFF < 32) { + code->SHL(32, R(tmp), R(CL)); + code->SETcc(CC_C, MJitStateCFlag()); + auto jmp_to_end_1 = code->J(); + // } else if (Rs & 0xFF > 32) { + code->SetJumpTarget(Rs_gt32); + code->MOV(32, R(tmp), Imm32(0)); + code->MOV(8, MJitStateCFlag(), Imm8(0)); + auto jmp_to_end_2 = code->J(); + // } else if (Rs & 0xFF == 32) { + code->SetJumpTarget(Rs_eq32); + code->BT(32, R(tmp), Imm8(0)); + code->SETcc(CC_C, MJitStateCFlag()); + code->MOV(32, R(tmp), Imm32(0)); + // } + code->SetJumpTarget(jmp_to_end_1); + code->SetJumpTarget(jmp_to_end_2); + code->SetJumpTarget(Rs_zero); + } + break; + } + case ShiftType::LSR: { // Logical shift right by register + if (!do_shifter_carry_out) { + code->SHR(32, R(tmp), R(RCX)); + + code->CMP(32, R(RCX), Imm8(32)); + X64Reg zero = reg_alloc.AllocTemp(); + code->MOV(32, R(zero), Imm32(0)); + code->CMOVcc(32, tmp, R(zero), CC_NB); + reg_alloc.UnlockTemp(zero); + } else { + code->CMP(32, R(RCX), Imm8(32)); + auto Rs_gt32 = code->J_CC(CC_A); + auto Rs_eq32 = code->J_CC(CC_E); + // if (Rs & 0xFF == 0) goto end; + code->TEST(32, R(RCX), R(RCX)); + auto Rs_zero = code->J_CC(CC_Z); + // if (Rs & 0xFF < 32) { + code->SHR(32, R(tmp), R(RCX)); + code->SETcc(CC_C, MJitStateCFlag()); + auto jmp_to_end_1 = code->J(); + // } else if (Rs & 0xFF > 32) { + code->SetJumpTarget(Rs_gt32); + code->MOV(32, R(tmp), Imm32(0)); + code->MOV(8, MJitStateCFlag(), Imm8(0)); + auto jmp_to_end_2 = code->J(); + // } else if (Rs & 0xFF == 32) { + code->SetJumpTarget(Rs_eq32); + code->BT(32, R(tmp), Imm8(31)); + code->SETcc(CC_C, MJitStateCFlag()); + code->MOV(32, R(tmp), Imm32(0)); + // } + code->SetJumpTarget(jmp_to_end_1); + code->SetJumpTarget(jmp_to_end_2); + code->SetJumpTarget(Rs_zero); + } + break; + } + case ShiftType::ASR: { // Arithmetic shift right by register + if (!do_shifter_carry_out) { + code->CMP(32, R(RCX), Imm8(31)); + auto Rs_gt31 = code->J_CC(CC_A); + // if (Rs & 0xFF <= 31) { + code->SAR(32, R(tmp), R(CL)); + auto jmp_to_end = code->J(); + // } else { + code->SetJumpTarget(Rs_gt31); + code->SAR(32, R(tmp), Imm8(31)); // Verified. + // } + code->SetJumpTarget(jmp_to_end); + } else { + code->CMP(32, R(RCX), Imm8(31)); + auto Rs_gt31 = code->J_CC(CC_A); + // if (Rs & 0xFF == 0) goto end; + code->TEST(32, R(RCX), R(RCX)); + auto Rs_zero = code->J_CC(CC_Z); + // if (Rs & 0xFF <= 31) { + code->SAR(32, R(tmp), R(CL)); + code->SETcc(CC_C, MJitStateCFlag()); + auto jmp_to_end = code->J(); + // } else if (Rs & 0xFF > 31) { + code->SetJumpTarget(Rs_gt31); + code->SAR(32, R(tmp), Imm8(31)); // Verified. + code->BT(32, R(tmp), Imm8(31)); + code->SETcc(CC_C, MJitStateCFlag()); + // } + code->SetJumpTarget(jmp_to_end); + code->SetJumpTarget(Rs_zero); + } + break; + } + case ShiftType::ROR: { // Rotate right by register + if (!do_shifter_carry_out) { + code->AND(32, R(RCX), Imm32(0x1F)); + code->ROR(32, R(tmp), R(CL)); + } else { + // if (Rs & 0xFF == 0) goto end; + code->TEST(32, R(RCX), R(RCX)); + auto Rs_zero = code->J_CC(CC_Z); + + code->AND(32, R(RCX), Imm32(0x1F)); + auto zero_1F = code->J_CC(CC_Z); + // if (Rs & 0x1F != 0) { + code->ROR(32, R(tmp), R(CL)); + code->SETcc(CC_C, MJitStateCFlag()); + auto jmp_to_end = code->J(); + // } else { + code->SetJumpTarget(zero_1F); + code->BT(32, R(tmp), Imm8(31)); + code->SETcc(CC_C, MJitStateCFlag()); + // } + code->SetJumpTarget(jmp_to_end); + code->SetJumpTarget(Rs_zero); + } + break; + } + default: + UNREACHABLE(); + break; + } // switch (shift) + + reg_alloc.UnlockX64(RCX); + + return tmp; +} + +void JitX64::ADC_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->ADC(32, R(Rd), Imm32(immediate)); + }); + + if (S) { + UpdateFlagsNZCV(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ADC_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->ADC(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZCV(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ADC_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->ADC(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZCV(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ADD_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->ADD(32, R(Rd), Imm32(immediate)); + }); + + if (S) { + UpdateFlagsNZCV(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ADD_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->ADD(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZCV(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ADD_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->ADD(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZCV(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::AND_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->AND(32, R(Rd), Imm32(immediate)); + }); + + if (S) { + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::AND_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->AND(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + // C updated by CompileDataProcessingHelper_reg + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::AND_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->AND(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + // C updated by CompileDataProcessingHelper_reg + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::BIC_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->AND(32, R(Rd), Imm32(~immediate)); + }); + + if (S) { + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::BIC_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + // TODO: Use ANDN instead. + code->NOT(32, R(tmp)); + code->AND(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::BIC_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + // TODO: Use ANDN instead. + code->NOT(32, R(tmp)); + code->AND(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::CMN_imm(Cond cond, ArmReg Rn_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + X64Reg tmp = reg_alloc.AllocTemp(); + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->MOV(32, R(tmp), Rn); + reg_alloc.UnlockArm(Rn_index); + } else { + code->MOV(32, R(tmp), Imm32(GetReg15Value())); + } + + code->ADD(32, R(tmp), Imm32(immediate)); + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsNZCV(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::CMN_reg(Cond cond, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->ADD(32, R(tmp), Rn); + reg_alloc.UnlockArm(Rn_index); + } else { + code->ADD(32, R(tmp), Imm32(GetReg15Value())); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsNZCV(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::CMN_rsr(Cond cond, ArmReg Rn_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->ADD(32, R(tmp), Rn); + reg_alloc.UnlockArm(Rn_index); + } else { + code->ADD(32, R(tmp), Imm32(GetReg15Value())); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsNZCV(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::CMP_imm(Cond cond, ArmReg Rn_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->CMP(32, Rn, Imm32(immediate)); + reg_alloc.UnlockArm(Rn_index); + } else { + // TODO: Optimize this + X64Reg tmp = reg_alloc.AllocTemp(); + code->MOV(32, R(tmp), Imm32(GetReg15Value())); + code->CMP(32, R(tmp), Imm32(immediate)); + reg_alloc.UnlockTemp(tmp); + } + + UpdateFlagsC_complement(); + UpdateFlagsNZV(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::CMP_reg(Cond cond, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->CMP(32, Rn, R(tmp)); + reg_alloc.UnlockArm(Rn_index); + } else { + // TODO: Optimize this + X64Reg tmp2 = reg_alloc.AllocTemp(); + code->MOV(32, R(tmp2), Imm32(GetReg15Value())); + code->CMP(32, R(tmp2), R(tmp)); + reg_alloc.UnlockTemp(tmp2); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsC_complement(); + UpdateFlagsNZV(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::CMP_rsr(Cond cond, ArmReg Rn_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->CMP(32, Rn, R(tmp)); + reg_alloc.UnlockArm(Rn_index); + } else { + // TODO: Optimize this + X64Reg tmp2 = reg_alloc.AllocTemp(); + code->MOV(32, R(tmp2), Imm32(GetReg15Value())); + code->CMP(32, R(tmp2), R(tmp)); + reg_alloc.UnlockTemp(tmp2); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsC_complement(); + UpdateFlagsNZV(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::EOR_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->XOR(32, R(Rd), Imm32(immediate)); + }); + + if (S) { + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::EOR_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->XOR(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::EOR_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->XOR(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::MOV_imm(Cond cond, bool S, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + Gen::OpArg Rd = reg_alloc.LockArmForWrite(Rd_index); + code->MOV(32, Rd, Imm32(immediate)); + reg_alloc.UnlockArm(Rd_index); + + if (S) { + Gen::OpArg Rd = reg_alloc.LockArmForRead(Rd_index); + code->CMP(32, Rd, Imm32(0)); + reg_alloc.UnlockArm(Rd_index); + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::MOV_reg(Cond cond, bool S, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, S); + + Gen::OpArg Rd = reg_alloc.LockArmForWrite(Rd_index); + code->MOV(32, Rd, R(tmp)); + reg_alloc.UnlockArm(Rd_index); + + if (S) { + code->CMP(32, R(tmp), Imm32(0)); + UpdateFlagsNZ(); + } + + reg_alloc.UnlockTemp(tmp); + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::MOV_rsr(Cond cond, bool S, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, S); + + Gen::OpArg Rd = reg_alloc.LockArmForWrite(Rd_index); + code->MOV(32, Rd, R(tmp)); + reg_alloc.UnlockArm(Rd_index); + + if (S) { + code->CMP(32, R(tmp), Imm32(0)); + UpdateFlagsNZ(); + } + + reg_alloc.UnlockTemp(tmp); + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::MVN_imm(Cond cond, bool S, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + Gen::OpArg Rd = reg_alloc.LockArmForWrite(Rd_index); + code->MOV(32, Rd, Imm32(~immediate)); + reg_alloc.UnlockArm(Rd_index); + + if (S) { + Gen::OpArg Rd = reg_alloc.LockArmForRead(Rd_index); + code->CMP(32, Rd, Imm32(0)); + reg_alloc.UnlockArm(Rd_index); + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::MVN_reg(Cond cond, bool S, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, S); + code->NOT(32, R(tmp)); + + Gen::OpArg Rd = reg_alloc.LockArmForWrite(Rd_index); + code->MOV(32, Rd, R(tmp)); + reg_alloc.UnlockArm(Rd_index); + + if (S) { + code->CMP(32, R(tmp), Imm32(0)); + UpdateFlagsNZ(); + } + + reg_alloc.UnlockTemp(tmp); + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::MVN_rsr(Cond cond, bool S, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, S); + code->NOT(32, R(tmp)); + + Gen::OpArg Rd = reg_alloc.LockArmForWrite(Rd_index); + code->MOV(32, Rd, R(tmp)); + reg_alloc.UnlockArm(Rd_index); + + if (S) { + code->CMP(32, R(tmp), Imm32(0)); + UpdateFlagsNZ(); + } + + reg_alloc.UnlockTemp(tmp); + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ORR_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->OR(32, R(Rd), Imm32(immediate)); + }); + + if (S) { + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ORR_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->OR(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::ORR_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, S); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->OR(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZ(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::RSB_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper_Reverse(Rn_index, Rd_index, [&](X64Reg Rd) { + code->MOV(32, R(Rd), Imm32(immediate)); + + if (Rn_index == ArmReg::PC) { + code->SUB(32, R(Rd), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->SUB(32, R(Rd), Rn); + reg_alloc.UnlockArm(Rn_index); + } + }); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::RSB_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + CompileDataProcessingHelper_Reverse(Rn_index, Rd_index, [&](X64Reg Rd) { + code->MOV(32, R(Rd), R(tmp)); + + if (Rn_index == ArmReg::PC) { + code->SUB(32, R(Rd), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->SUB(32, R(Rd), Rn); + reg_alloc.UnlockArm(Rn_index); + } + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::RSB_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + CompileDataProcessingHelper_Reverse(Rn_index, Rd_index, [&](X64Reg Rd) { + code->MOV(32, R(Rd), R(tmp)); + + if (Rn_index == ArmReg::PC) { + code->SUB(32, R(Rd), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->SUB(32, R(Rd), Rn); + reg_alloc.UnlockArm(Rn_index); + } + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::RSC_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper_Reverse(Rn_index, Rd_index, [&](X64Reg Rd) { + code->MOV(32, R(Rd), Imm32(immediate)); + + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->CMC(); + + if (Rn_index == ArmReg::PC) { + code->SBB(32, R(Rd), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->SBB(32, R(Rd), Rn); + reg_alloc.UnlockArm(Rn_index); + } + }); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::RSC_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + CompileDataProcessingHelper_Reverse(Rn_index, Rd_index, [&](X64Reg Rd) { + code->MOV(32, R(Rd), R(tmp)); + + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->CMC(); + + if (Rn_index == ArmReg::PC) { + code->SBB(32, R(Rd), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->SBB(32, R(Rd), Rn); + reg_alloc.UnlockArm(Rn_index); + } + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::RSC_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + CompileDataProcessingHelper_Reverse(Rn_index, Rd_index, [&](X64Reg Rd) { + code->MOV(32, R(Rd), R(tmp)); + + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->CMC(); + + if (Rn_index == ArmReg::PC) { + code->SBB(32, R(Rd), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->SBB(32, R(Rd), Rn); + reg_alloc.UnlockArm(Rn_index); + } + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::SBC_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->CMC(); + code->SBB(32, R(Rd), Imm32(immediate)); + }); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::SBC_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->CMC(); + code->SBB(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::SBC_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->BT(32, MJitStateCFlag(), Imm8(0)); + code->CMC(); + code->SBB(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::SUB_imm(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->SUB(32, R(Rd), Imm32(immediate)); + }); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::SUB_reg(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->SUB(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + +void JitX64::SUB_rsr(Cond cond, bool S, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, false); + + CompileDataProcessingHelper(Rn_index, Rd_index, [&](X64Reg Rd) { + code->SUB(32, R(Rd), R(tmp)); + }); + + reg_alloc.UnlockTemp(tmp); + + if (S) { + UpdateFlagsNZV(); + UpdateFlagsC_complement(); + } + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + CompileReturnToDispatch(); + } +} + + +void JitX64::TEQ_imm(Cond cond, ArmReg Rn_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + X64Reg Rn_tmp = reg_alloc.AllocTemp(); + + if (Rn_index == ArmReg::PC) { + code->MOV(32, R(Rn_tmp), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn_real = reg_alloc.LockArmForRead(Rn_index); + code->MOV(32, R(Rn_tmp), Rn_real); + reg_alloc.UnlockArm(Rn_index); + } + + code->XOR(32, R(Rn_tmp), Imm32(immediate)); + + reg_alloc.UnlockTemp(Rn_tmp); + + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + + current.arm_pc += GetInstSize(); +} + +void JitX64::TEQ_reg(Cond cond, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, true); + + if (Rn_index == ArmReg::PC) { + code->XOR(32, R(tmp), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->XOR(32, R(tmp), Rn); + reg_alloc.UnlockArm(Rn_index); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsNZ(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::TEQ_rsr(Cond cond, ArmReg Rn_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, true); + + if (Rn_index == ArmReg::PC) { + code->XOR(32, R(tmp), Imm32(GetReg15Value())); + } else { + Gen::OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->XOR(32, R(tmp), Rn); + reg_alloc.UnlockArm(Rn_index); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsNZ(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::TST_imm(Cond cond, ArmReg Rn_index, int rotate, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + u32 immediate = rotr(imm8, rotate * 2); + + X64Reg Rn; + + if (Rn_index == ArmReg::PC) { + Rn = reg_alloc.AllocTemp(); + code->MOV(32, R(Rn), Imm32(GetReg15Value())); + } else { + Rn = reg_alloc.BindArmForRead(Rn_index); + } + + code->TEST(32, R(Rn), Imm32(immediate)); + + if (Rn_index == ArmReg::PC) { + reg_alloc.UnlockTemp(Rn); + } else { + reg_alloc.UnlockArm(Rn_index); + } + + UpdateFlagsNZ(); + if (rotate != 0) { + code->MOV(32, MJitStateCFlag(), Imm32(immediate & 0x80000000 ? 1 : 0)); + } + + current.arm_pc += GetInstSize(); +} + +void JitX64::TST_reg(Cond cond, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_reg(imm5, shift, Rm_index, true); + + if (Rn_index == ArmReg::PC) { + code->TEST(32, R(tmp), Imm32(GetReg15Value())); + } else { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->TEST(32, R(tmp), Rn); + reg_alloc.UnlockArm(Rn_index); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsNZ(); + + current.arm_pc += GetInstSize(); +} + +void JitX64::TST_rsr(Cond cond, ArmReg Rn_index, ArmReg Rs_index, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + Gen::X64Reg tmp = CompileDataProcessingHelper_rsr(Rs_index, shift, Rm_index, true); + + if (Rn_index == ArmReg::PC) { + code->TEST(32, R(tmp), Imm32(GetReg15Value())); + } else { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->TEST(32, R(tmp), Rn); + reg_alloc.UnlockArm(Rn_index); + } + + reg_alloc.UnlockTemp(tmp); + + UpdateFlagsNZ(); + + current.arm_pc += GetInstSize(); +} + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/exception_generating.cpp b/src/core/arm/jit_x64/instructions/exception_generating.cpp new file mode 100644 index 000000000..8ac2c3209 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/exception_generating.cpp @@ -0,0 +1,68 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/assert.h" +#include "common/logging/log.h" +#include "common/x64/abi.h" + +#include "core/arm/jit_x64/jit_x64.h" +#include "core/hle/svc.h" + +namespace JitX64 { + +using namespace Gen; + +static void Breakpoint(u32 imm) { + LOG_DEBUG(Core_ARM11, "Breakpoint instruction hit. Immediate: 0x%08X", imm); +} + +void JitX64::BKPT(Cond cond, ArmImm12 imm12, ArmImm4 imm4) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(false, "BKPT instruction @ pc=0x%08X", current.arm_pc); + + reg_alloc.FlushX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_PARAM1); + + code->MOV(32, R(ABI_PARAM1), Imm32((imm12 << 4) | imm4)); + CompileCallHost(reinterpret_cast(&Breakpoint)); + + reg_alloc.UnlockX64(ABI_PARAM1); + + current.arm_pc += GetInstSize(); +} + +static void ServiceCall(u64 imm) { + SVC::CallSVC(imm & 0xFFFF); +} + +void JitX64::SVC(Cond cond, ArmImm24 imm24) { + cond_manager.CompileCond(cond); + + // Flush and write out absolutely everything. + code->MOV(32, MJitStateArmPC(), Imm32(current.arm_pc)); + reg_alloc.FlushEverything(); + + reg_alloc.LockX64(ABI_PARAM1); + code->MOV(64, R(ABI_PARAM1), Imm32(imm24)); + CompileCallHost(reinterpret_cast(&ServiceCall)); + reg_alloc.UnlockX64(ABI_PARAM1); + + // Some service calls require a task switch, so go back to the dispatcher to check. + current.arm_pc += GetInstSize(); + code->ADD(32, MJitStateArmPC(), Imm32(GetInstSize())); + CompileReturnToDispatch(); + + stop_compilation = true; +} + +void JitX64::UDF() { + cond_manager.Always(); + + ASSERT_MSG(false, "UDF instruction @ pc=0x%08X", current.arm_pc); + + current.arm_pc += GetInstSize(); +} + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/extension.cpp b/src/core/arm/jit_x64/instructions/extension.cpp new file mode 100644 index 000000000..5d631e8ca --- /dev/null +++ b/src/core/arm/jit_x64/instructions/extension.cpp @@ -0,0 +1,22 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::SXTAB(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SXTAB16(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SXTAH(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SXTB(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SXTB16(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SXTH(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UXTAB(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UXTAB16(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UXTAH(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UXTB(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UXTB16(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UXTH(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/helper/load_store.cpp b/src/core/arm/jit_x64/instructions/helper/load_store.cpp new file mode 100644 index 000000000..db17335ab --- /dev/null +++ b/src/core/arm/jit_x64/instructions/helper/load_store.cpp @@ -0,0 +1,73 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/common_types.h" +#include "common/swap.h" + +#include "core/arm/jit_x64/instructions/helper/load_store.h" +#include "core/memory.h" + +namespace JitX64 { + +u64 Load64LE(u32 addr) { + // TODO: Improve this. + return Memory::Read32(addr) | (static_cast(Memory::Read32(addr + 4)) << 32); +} + +u64 Load64BE(u32 addr) { + // TODO: Improve this. + return Common::swap32(Memory::Read32(addr)) | (static_cast(Common::swap32(Memory::Read32(addr + 4))) << 32); +} + +void Store64LE(u32 addr, u32 v1, u32 v2) { + Memory::Write32(addr, v1); + Memory::Write32(addr + 4, v2); +} + +void Store64BE(u32 addr, u32 v1, u32 v2) { + Memory::Write32(addr, Common::swap32(v2)); + Memory::Write32(addr + 4, Common::swap32(v1)); +} + +u32 Load32LE(u32 addr) { + return Memory::Read32(addr); +} + +u32 Load32BE(u32 addr) { + return Common::swap32(Memory::Read32(addr)); +} + +void Store32LE(u32 addr, u32 value) { + Memory::Write32(addr, value); +} + +void Store32BE(u32 addr, u32 value) { + Memory::Write32(addr, Common::swap32(value)); +} + +u16 Load16LE(u32 addr) { + return Memory::Read16(addr); +} + +u16 Load16BE(u32 addr) { + return Common::swap16(Memory::Read16(addr)); +} + +void Store16LE(u32 addr, u16 value) { + Memory::Write16(addr, value); +} + +void Store16BE(u32 addr, u16 value) { + Memory::Write16(addr, Common::swap16(value)); +} + +u32 Load8(u32 addr) { + return Memory::Read8(addr); +} + +void Store8(u32 addr, u8 value) { + Memory::Write8(addr, value); +} + +} \ No newline at end of file diff --git a/src/core/arm/jit_x64/instructions/helper/load_store.h b/src/core/arm/jit_x64/instructions/helper/load_store.h new file mode 100644 index 000000000..294871750 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/helper/load_store.h @@ -0,0 +1,33 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include "common/common_types.h" + +namespace JitX64 { + +// TODO: Set up an appropriately mapped region of memory to use instead of compiling CALL instructions. + +constexpr u32 RESERVATION_GRANULE_MASK = 0xFFFFFFF8; + +u64 Load64LE(u32 addr); +u64 Load64BE(u32 addr); +void Store64LE(u32 addr, u32 v1, u32 v2); +void Store64BE(u32 addr, u32 v1, u32 v2); + +u32 Load32LE(u32 addr); +u32 Load32BE(u32 addr); +void Store32LE(u32 addr, u32 value); +void Store32BE(u32 addr, u32 value); + +u16 Load16LE(u32 addr); +u16 Load16BE(u32 addr); +void Store16LE(u32 addr, u16 value); +void Store16BE(u32 addr, u16 value); + +u32 Load8(u32 addr); +void Store8(u32 addr, u8 value); + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/hint.cpp b/src/core/arm/jit_x64/instructions/hint.cpp new file mode 100644 index 000000000..2a6edba61 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/hint.cpp @@ -0,0 +1,15 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::SEV() { CompileInterpretInstruction(); } +void JitX64::PLD() { CompileInterpretInstruction(); } +void JitX64::WFI() { CompileInterpretInstruction(); } +void JitX64::WFE() { CompileInterpretInstruction(); } +void JitX64::YIELD() { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/load_store.cpp b/src/core/arm/jit_x64/instructions/load_store.cpp new file mode 100644 index 000000000..ade52e021 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/load_store.cpp @@ -0,0 +1,1035 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/bit_set.h" +#include "common/swap.h" +#include "common/x64/abi.h" + +#include "core/arm/jit_x64/jit_x64.h" +#include "core/arm/jit_x64/instructions/helper/load_store.h" +#include "core/memory.h" + +namespace JitX64 { + +// TODO: Optimization: Loads from read-only memory regions can be turned into immediate constant loads. + +using namespace Gen; + +/// This function assumes that the value of Rn is already in dest except for R15. +void JitX64::LoadAndStoreWordOrUnsignedByte_Immediate_Helper(X64Reg dest, bool U, ArmReg Rn_index, ArmImm12 imm12) { + // address = Rn +/- imm12 + + if (Rn_index == ArmReg::PC) { + u32 address; + if (U) { + address = GetReg15Value_WordAligned() + imm12; + } else { + address = GetReg15Value_WordAligned() - imm12; + } + code->MOV(32, R(dest), Imm32(address)); + } else { + if (U) { + code->ADD(32, R(dest), Imm32(imm12)); + } else { + code->SUB(32, R(dest), Imm32(imm12)); + } + } +} + +void JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset(X64Reg dest, bool U, ArmReg Rn_index, ArmImm12 imm12) { + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->MOV(32, R(dest), Rn); + reg_alloc.UnlockArm(Rn_index); + } + + LoadAndStoreWordOrUnsignedByte_Immediate_Helper(dest, U, Rn_index, imm12); +} + +void JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed(X64Reg dest, bool U, ArmReg Rn_index, ArmImm12 imm12) { + ASSERT_MSG(Rn_index != ArmReg::PC, "UNPREDICTABLE"); + + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + + LoadAndStoreWordOrUnsignedByte_Immediate_Helper(Rn, U, Rn_index, imm12); + + code->MOV(32, R(dest), R(Rn)); + reg_alloc.UnlockArm(Rn_index); +} + +void JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed(X64Reg dest, bool U, ArmReg Rn_index, ArmImm12 imm12) { + ASSERT_MSG(Rn_index != ArmReg::PC, "UNPREDICTABLE"); + + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->MOV(32, R(dest), R(Rn)); + + LoadAndStoreWordOrUnsignedByte_Immediate_Helper(Rn, U, Rn_index, imm12); + + reg_alloc.UnlockArm(Rn_index); +} + +/// This function assumes that the value of Rn is already in dest. +void JitX64::LoadAndStoreWordOrUnsignedByte_Register_Helper(X64Reg dest, bool U, ArmReg Rn_index, ArmReg Rm_index) { + // address = Rn +/- Rm + + ASSERT_MSG(Rm_index != ArmReg::PC, "UNPREDICTABLE"); + + if (Rm_index == Rn_index) { + if (U) { + // address = Rn + Rn + code->SHL(32, R(dest), Imm8(1)); + } else { + // address = Rn - Rn + code->MOV(32, R(dest), Imm32(0)); + } + return; + } + + OpArg Rm = reg_alloc.LockArmForRead(Rm_index); + + if (U) { + // address = Rn + Rm + code->ADD(32, R(dest), Rm); + } else { + // address = Rn - Rm + code->SUB(32, R(dest), Rm); + } + + reg_alloc.UnlockArm(Rm_index); +} + +/// This function assumes that the value of Rn is already in dest. +void JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegister_Helper(X64Reg dest, bool U, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + if (imm5 == 0 && shift == ShiftType::LSL) { + LoadAndStoreWordOrUnsignedByte_Register_Helper(dest, U, Rn_index, Rm_index); + return; + } + + // index = Rm LSL imm5 / Rm LSR imm5 / Rm ASR imm5 / Rm ROR imm5 / Rm RRX + // address = Rn +/- index + + ASSERT_MSG(Rm_index != ArmReg::PC, "UNPREDICTABLE"); + + // TODO: Optimizations when Rn_index == Rm_index maybe. + + X64Reg index = reg_alloc.AllocTemp(); + if (Rn_index == Rm_index) { + code->MOV(32, R(index), R(dest)); + } else { + OpArg Rm = reg_alloc.LockArmForRead(Rm_index); + code->MOV(32, R(index), Rm); + reg_alloc.UnlockArm(Rm_index); + } + + CompileShifter_imm(index, imm5, shift, false); + + if (U) { + // address = Rn + index + code->ADD(32, R(dest), R(index)); + } else { + // address = Rn - index + code->SUB(32, R(dest), R(index)); + } + + reg_alloc.UnlockTemp(index); +} + +void JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset(X64Reg dest, bool U, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + if (Rn_index != ArmReg::PC) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->MOV(32, R(dest), Rn); + reg_alloc.UnlockArm(Rn_index); + } else { + code->MOV(32, R(dest), Imm32(GetReg15Value_WordAligned())); + } + + LoadAndStoreWordOrUnsignedByte_ScaledRegister_Helper(dest, U, Rn_index, imm5, shift, Rm_index); +} + +void JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed(X64Reg dest, bool U, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + ASSERT_MSG(Rn_index != ArmReg::PC, "UNPREDICTABLE"); + + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + + LoadAndStoreWordOrUnsignedByte_ScaledRegister_Helper(Rn, U, Rn_index, imm5, shift, Rm_index); + + code->MOV(32, R(dest), R(Rn)); + reg_alloc.UnlockArm(Rn_index); +} + +void JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed(X64Reg dest, bool U, ArmReg Rn_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + ASSERT_MSG(Rn_index != ArmReg::PC, "UNPREDICTABLE"); + + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->MOV(32, R(dest), R(Rn)); + + LoadAndStoreWordOrUnsignedByte_ScaledRegister_Helper(Rn, U, Rn_index, imm5, shift, Rm_index); + + reg_alloc.UnlockArm(Rn_index); +} + +static void GetValueOfRegister(XEmitter* code, RegAlloc& reg_alloc, u32 r15_value, X64Reg dest_x64_reg, ArmReg src_arm_reg) { + if (src_arm_reg != ArmReg::PC) { + OpArg Rd = reg_alloc.LockArmForRead(src_arm_reg); + code->MOV(32, R(dest_x64_reg), Rd); + reg_alloc.UnlockArm(src_arm_reg); + } else { + // The following is IMPLEMENTATION DEFINED + code->MOV(32, R(dest_x64_reg), Imm32(r15_value)); + } +} + +/** +* This function implements address resolution logic common to all the addressing mode 2 store/load instructions. +* The address is loaded into ABI_PARAM1. +*/ +template +static void LoadStoreCommon_AddrMode2(JitX64* jit, RegAlloc& reg_alloc, bool P, bool W, OffsetFn offset_fn, PreFn pre_fn, PostFn post_fn, Args... args) { + constexpr X64Reg address = ABI_PARAM1; + reg_alloc.FlushX64(address); + reg_alloc.LockX64(address); + + if (P) { + if (!W) { + (jit->*offset_fn)(address, args...); + } else { + (jit->*pre_fn)(address, args...); + } + } else { + if (!W) { + (jit->*post_fn)(address, args...); + } else { + ASSERT_MSG(false, "Translate load/store instructions are unsupported"); + } + } +} + +// Load/Store Instructions: Addressing Mode 2 + +void JitX64::LDR_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm12 imm12) { + cond_manager.CompileCond(cond); + + // Rd == R15 is UNPREDICTABLE only if address[1:0] is not 0b00 or if value loaded into R15[1:0] is 0b10. + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, imm12); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load32LE : &Load32BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + // TODO: Could be optimized as a rebind instead. + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOV(32, R(Rd), R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + code->AND(32, MJitStateArmPC(), Imm32(0xFFFFFFFE)); + code->BT(32, R(ABI_RETURN), Imm8(0)); + code->SETcc(CC_C, MJitStateTFlag()); + CompileReturnToDispatch(); + } +} + +void JitX64::LDR_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, imm5, shift, Rm_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load32LE : &Load32BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + // TODO: Could be optimized as a rebind instead. + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOV(32, R(Rd), R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); + if (Rd_index == ArmReg::PC) { + code->AND(32, MJitStateArmPC(), Imm32(0xFFFFFFFE)); + code->BT(32, R(ABI_RETURN), Imm8(0)); + code->SETcc(CC_C, MJitStateTFlag()); + CompileReturnToDispatch(); + } +} + +void JitX64::LDRB_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm12 imm12) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, imm12); + + CompileCallHost(reinterpret_cast(&Load8)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + // TODO: Could be optimized as a rebind instead. + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVZX(32, 8, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRB_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, imm5, shift, Rm_index); + + CompileCallHost(reinterpret_cast(&Load8)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + // TODO: Could be optimized as a rebind instead. + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVZX(32, 8, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STR_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm12 imm12) { + cond_manager.CompileCond(cond); + + // Rd_index == R15 is IMPLEMENTATION DEFINED + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, imm12); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store32LE : &Store32BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STR_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + // Rd_index == R15 is IMPLEMENTATION DEFINED + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, imm5, shift, Rm_index); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store32LE : &Store32BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STRB_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm12 imm12) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, imm12); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index); + + CompileCallHost(reinterpret_cast(&Store8)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STRB_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm5 imm5, ShiftType shift, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode2(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, imm5, shift, Rm_index); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index); + + CompileCallHost(reinterpret_cast(&Store8)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + + current.arm_pc += GetInstSize(); +} + +/** +* This function implements address resolution logic common to all the addressing mode 3 store/load instructions. +* The address is loaded into ABI_PARAM1. +*/ +template +static void LoadStoreCommon_AddrMode3(JitX64* jit, RegAlloc& reg_alloc, bool P, bool W, OffsetFn offset_fn, PreFn pre_fn, PostFn post_fn, Args... args) { + constexpr X64Reg address = ABI_PARAM1; + reg_alloc.FlushX64(address); + reg_alloc.LockX64(address); + + if (P) { + if (!W) { + (jit->*offset_fn)(address, args...); + } else { + (jit->*pre_fn)(address, args...); + } + } else { + if (!W) { + (jit->*post_fn)(address, args...); + } else { + ASSERT_MSG(false, "UNPREDICTABLE"); + } + } +} + +static ArmImm8 CombineImm8ab(ArmImm4 imm8a, ArmImm4 imm8b) { + return (imm8a << 4) | imm8b; +} + +// Load/Store Instructions: Addressing Mode 3 + +void JitX64::LDRD_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm4 imm8a, ArmImm4 imm8b) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index < ArmReg::R14, "UNPREDICTABLE"); + ASSERT_MSG(IsEvenArmReg(Rd_index), "UNDEFINED"); + if (W) + ASSERT_MSG(Rn_index != Rd_index && Rn_index != Rd_index + 1, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, CombineImm8ab(imm8a, imm8b)); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load64LE : &Load64BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd0 = reg_alloc.BindArmForWrite(Rd_index + 0); + X64Reg Rd1 = reg_alloc.BindArmForWrite(Rd_index + 1); + code->MOV(64, R(Rd0), R(ABI_RETURN)); + code->SHR(64, R(ABI_RETURN), Imm8(32)); + code->MOV(32, R(Rd1), R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index + 0); + reg_alloc.UnlockArm(Rd_index + 1); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRD_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index < ArmReg::R14, "UNPREDICTABLE"); + ASSERT_MSG(IsEvenArmReg(Rd_index), "UNDEFINED"); + ASSERT_MSG(Rm_index != Rd_index && Rm_index != Rd_index + 1, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index && Rn_index != Rd_index + 1, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, 0, ShiftType::LSL, Rm_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load64LE : &Load64BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd0 = reg_alloc.BindArmForWrite(Rd_index + 0); + X64Reg Rd1 = reg_alloc.BindArmForWrite(Rd_index + 1); + code->MOV(64, R(Rd0), R(ABI_RETURN)); + code->SHR(64, R(ABI_RETURN), Imm8(32)); + code->MOV(32, R(Rd1), R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index + 0); + reg_alloc.UnlockArm(Rd_index + 1); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRH_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm4 imm8a, ArmImm4 imm8b) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, CombineImm8ab(imm8a, imm8b)); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load16LE : &Load16BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVZX(32, 16, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRH_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, 0, ShiftType::LSL, Rm_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load16LE : &Load16BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVZX(32, 16, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRSB_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm4 imm8a, ArmImm4 imm8b) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, CombineImm8ab(imm8a, imm8b)); + + CompileCallHost(reinterpret_cast(&Load8)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVSX(32, 8, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRSB_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, 0, ShiftType::LSL, Rm_index); + + CompileCallHost(reinterpret_cast(&Load8)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVSX(32, 8, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRSH_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm4 imm8a, ArmImm4 imm8b) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, CombineImm8ab(imm8a, imm8b)); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load16LE : &Load16BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVSX(32, 16, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRSH_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rn_index != Rd_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, 0, ShiftType::LSL, Rm_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load16LE : &Load16BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVSX(32, 16, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STRD_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm4 imm8a, ArmImm4 imm8b) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index < ArmReg::R14, "UNPREDICTABLE"); + ASSERT_MSG(IsEvenArmReg(Rd_index), "UNDEFINED"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, CombineImm8ab(imm8a, imm8b)); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + reg_alloc.FlushX64(ABI_PARAM3); + reg_alloc.LockX64(ABI_PARAM3); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index + 0); + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM3, Rd_index + 1); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store64LE : &Store64BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + reg_alloc.UnlockX64(ABI_PARAM3); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STRD_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index < ArmReg::R14, "UNPREDICTABLE"); + ASSERT_MSG(IsEvenArmReg(Rd_index), "UNDEFINED"); + if (W) + ASSERT_MSG(Rn_index != Rd_index && Rn_index != Rd_index + 1, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, 0, ShiftType::LSL, Rm_index); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + reg_alloc.FlushX64(ABI_PARAM3); + reg_alloc.LockX64(ABI_PARAM3); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index + 0); + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM3, Rd_index + 1); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store64LE : &Store64BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + reg_alloc.UnlockX64(ABI_PARAM3); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STRH_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmImm4 imm8a, ArmImm4 imm8b) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rd_index != Rn_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediateOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed, + U, Rn_index, CombineImm8ab(imm8a, imm8b)); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store16LE : &Store16BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STRH_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rd_index != ArmReg::PC, "UNPREDICTABLE"); + if (W) + ASSERT_MSG(Rd_index != Rn_index, "UNPREDICTABLE"); + + LoadStoreCommon_AddrMode3(this, reg_alloc, P, W, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed, + &JitX64::LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed, + U, Rn_index, 0, ShiftType::LSL, Rm_index); + + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + GetValueOfRegister(code, reg_alloc, GetReg15Value(), ABI_PARAM2, Rd_index); + + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store16LE : &Store16BE)); + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDRBT() { CompileInterpretInstruction(); } +void JitX64::LDRHT() { CompileInterpretInstruction(); } +void JitX64::LDRSBT() { CompileInterpretInstruction(); } +void JitX64::LDRSHT() { CompileInterpretInstruction(); } +void JitX64::LDRT() { CompileInterpretInstruction(); } +void JitX64::STRBT() { CompileInterpretInstruction(); } +void JitX64::STRHT() { CompileInterpretInstruction(); } +void JitX64::STRT() { CompileInterpretInstruction(); } + +// Load/Store multiple instructions + +static void LoadAndStoreMultiple_IncrementAfter(XEmitter* code, RegAlloc& reg_alloc, bool W, ArmReg Rn_index, ArmRegList list, std::function call) { + if (W) { + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), R(Rn)); + reg_alloc.UnlockArm(Rn_index); + + call(); + + Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->ADD(32, R(Rn), Imm8(4 * Common::CountSetBits(list))); + reg_alloc.UnlockArm(Rn_index); + } else { + OpArg Rn = reg_alloc.LockArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), Rn); + reg_alloc.UnlockArm(Rn_index); + call(); + } +} + +static void LoadAndStoreMultiple_IncrementBefore(XEmitter* code, RegAlloc& reg_alloc, bool W, ArmReg Rn_index, ArmRegList list, std::function call) { + if (W) { + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), R(Rn)); + code->ADD(32, R(ABI_PARAM1), Imm8(4)); + reg_alloc.UnlockArm(Rn_index); + + call(); + + Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->ADD(32, R(Rn), Imm8(4 * Common::CountSetBits(list))); + reg_alloc.UnlockArm(Rn_index); + } else { + OpArg Rn = reg_alloc.LockArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), Rn); + code->ADD(32, R(ABI_PARAM1), Imm8(4)); + reg_alloc.UnlockArm(Rn_index); + call(); + } +} + +static void LoadAndStoreMultiple_DecrementAfter(XEmitter* code, RegAlloc& reg_alloc, bool W, ArmReg Rn_index, ArmRegList list, std::function call) { + if (W) { + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), R(Rn)); + code->SUB(32, R(ABI_PARAM1), Imm32(4 * Common::CountSetBits(list) - 4)); + reg_alloc.UnlockArm(Rn_index); + + call(); + + Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->SUB(32, R(Rn), Imm32(4 * Common::CountSetBits(list))); + reg_alloc.UnlockArm(Rn_index); + } else { + OpArg Rn = reg_alloc.LockArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), Rn); + code->SUB(32, R(ABI_PARAM1), Imm32(4 * Common::CountSetBits(list) - 4)); + reg_alloc.UnlockArm(Rn_index); + call(); + } +} + +static void LoadAndStoreMultiple_DecrementBefore(XEmitter* code, RegAlloc& reg_alloc, bool W, ArmReg Rn_index, ArmRegList list, std::function call) { + if (W && !(list & MakeRegList(Rn_index))) { + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->SUB(32, R(Rn), Imm32(4 * Common::CountSetBits(list))); + code->MOV(32, R(ABI_PARAM1), R(Rn)); + reg_alloc.UnlockArm(Rn_index); + call(); + } else if (W) { + X64Reg Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), R(Rn)); + code->SUB(32, R(ABI_PARAM1), Imm32(4 * Common::CountSetBits(list))); + reg_alloc.UnlockArm(Rn_index); + + call(); + + Rn = reg_alloc.BindArmForReadWrite(Rn_index); + code->SUB(32, R(Rn), Imm32(4 * Common::CountSetBits(list))); + reg_alloc.UnlockArm(Rn_index); + } else { + OpArg Rn = reg_alloc.LockArmForReadWrite(Rn_index); + code->MOV(32, R(ABI_PARAM1), Rn); + code->SUB(32, R(ABI_PARAM1), Imm32(4 * Common::CountSetBits(list))); + reg_alloc.UnlockArm(Rn_index); + call(); + } +} + +static void LoadAndStoreMultiple_Helper(XEmitter* code, RegAlloc& reg_alloc, bool P, bool U, bool W, ArmReg Rn_index, ArmRegList list, std::function call) { + reg_alloc.FlushX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_PARAM1); + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + reg_alloc.FlushX64(ABI_PARAM3); + reg_alloc.LockX64(ABI_PARAM3); + + for (int i = 0; i < 15; i++) { + if (list & (1 << i)) { + reg_alloc.FlushArm(static_cast(i)); + } + } + + code->MOV(32, R(ABI_PARAM2), Imm32(list)); + code->MOV(64, R(ABI_PARAM3), R(reg_alloc.JitStateReg())); + + if (!P && !U) { + LoadAndStoreMultiple_DecrementAfter(code, reg_alloc, W, Rn_index, list, call); + } else if (!P && U) { + LoadAndStoreMultiple_IncrementAfter(code, reg_alloc, W, Rn_index, list, call); + } else if (P && !U) { + LoadAndStoreMultiple_DecrementBefore(code, reg_alloc, W, Rn_index, list, call); + } else if (P && U) { + LoadAndStoreMultiple_IncrementBefore(code, reg_alloc, W, Rn_index, list, call); + } else { + UNREACHABLE(); + } + + reg_alloc.UnlockX64(ABI_PARAM1); + reg_alloc.UnlockX64(ABI_PARAM2); + reg_alloc.UnlockX64(ABI_PARAM3); +} + +static void ExecuteLDMLE(u32 start_address, u16 reg_list, JitState* jit_state) { + for (int i = 0; i < 16; i++) { + const u16 bit = 1 << i; + if (reg_list & bit) { + jit_state->cpu_state.Reg[i] = Memory::Read32(start_address); + start_address += 4; + } + } +} + +static void ExecuteLDMBE(u32 start_address, u16 reg_list, JitState* jit_state) { + for (int i = 0; i < 16; i++) { + const u16 bit = 1 << i; + if (reg_list & bit) { + jit_state->cpu_state.Reg[i] = Common::swap32(Memory::Read32(start_address)); + start_address += 4; + } + } +} + +void JitX64::LDM(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmRegList list) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC, "UNPREDICTABLE"); + ASSERT_MSG(list != 0, "UNPREDICTABLE"); + if (W && (list & MakeRegList(Rn_index))) + ASSERT_MSG(false, "UNPREDICTABLE"); + + // TODO: Optimize + + LoadAndStoreMultiple_Helper(code, reg_alloc, P, U, W, Rn_index, list, + [this](){ CompileCallHost(reinterpret_cast(!current.EFlag ? &ExecuteLDMLE : &ExecuteLDMBE)); }); + + current.arm_pc += GetInstSize(); + if (list & (1 << 15)) { + code->BT(32, MJitStateArmPC(), Imm8(0)); + code->SETcc(CC_C, MJitStateTFlag()); + code->AND(32, MJitStateArmPC(), Imm32(0xFFFFFFFE)); + CompileReturnToDispatch(); + } +} + +static void ExecuteSTMLE(u32 start_address, u16 reg_list, JitState* jit_state) { + for (int i = 0; i < 15; i++) { + const u16 bit = 1 << i; + if (reg_list & bit) { + Memory::Write32(start_address, jit_state->cpu_state.Reg[i]); + start_address += 4; + } + } + // Reading R15 here is IMPLEMENTATION DEFINED + if (reg_list & (1 << 15)) { + if (!jit_state->cpu_state.TFlag) { + Memory::Write32(start_address, jit_state->cpu_state.Reg[15] + 8); + } else { + Memory::Write32(start_address, jit_state->cpu_state.Reg[15] + 4); + } + } +} + +static void ExecuteSTMBE(u32 start_address, u16 reg_list, JitState* jit_state) { + for (int i = 0; i < 16; i++) { + const u16 bit = 1 << i; + if (reg_list & bit) { + Memory::Write32(start_address, Common::swap32(jit_state->cpu_state.Reg[i])); + start_address += 4; + } + } + // Reading R15 here is IMPLEMENTATION DEFINED + if (reg_list & (1 << 15)) { + if (!jit_state->cpu_state.TFlag) { + Memory::Write32(start_address, Common::swap32(jit_state->cpu_state.Reg[15] + 8)); + } else { + Memory::Write32(start_address, Common::swap32(jit_state->cpu_state.Reg[15] + 4)); + } + } +} + +void JitX64::STM(Cond cond, bool P, bool U, bool W, ArmReg Rn_index, ArmRegList list) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC, "UNPREDICTABLE"); + ASSERT_MSG(list != 0, "UNPREDICTABLE"); + if (W && (list & MakeRegList(Rn_index))) + ASSERT_MSG((list & (MakeRegList(Rn_index) - 1)) == 0, "UNPREDICTABLE"); + + // TODO: Optimize + + LoadAndStoreMultiple_Helper(code, reg_alloc, P, U, W, Rn_index, list, + [this](){ CompileCallHost(reinterpret_cast(!current.EFlag ? &ExecuteSTMLE : &ExecuteSTMBE)); }); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDM_usr() { CompileInterpretInstruction(); } +void JitX64::LDM_eret() { CompileInterpretInstruction(); } +void JitX64::STM_usr() { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/misc.cpp b/src/core/arm/jit_x64/instructions/misc.cpp new file mode 100644 index 000000000..30e0b74d2 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/misc.cpp @@ -0,0 +1,13 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::CLZ(Cond cond, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::NOP() { CompileInterpretInstruction(); } +void JitX64::SEL(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/multiply.cpp b/src/core/arm/jit_x64/instructions/multiply.cpp new file mode 100644 index 000000000..d86d0e6e2 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/multiply.cpp @@ -0,0 +1,42 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +// Multiply (Normal) instructions +void JitX64::MLA(Cond cond, bool S, ArmReg Rd, ArmReg Ra, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::MUL(Cond cond, bool S, ArmReg Rd, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } + +// Multiply (Long) instructions +void JitX64::SMLAL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMULL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::UMAAL(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::UMLAL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::UMULL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } + +// Multiply (Halfword) instructions +void JitX64::SMLALxy(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, bool M, bool N, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMLAxy(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, bool N, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMULxy(Cond cond, ArmReg Rd, ArmReg Rm, bool M, bool N, ArmReg Rn) { CompileInterpretInstruction(); } + +// Multiply (word by halfword) instructions +void JitX64::SMLAWy(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMULWy(Cond cond, ArmReg Rd, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } + +// Multiply (Most significant word) instructions +void JitX64::SMMLA(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool R, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMMLS(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool R, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMMUL(Cond cond, ArmReg Rd, ArmReg Rm, bool R, ArmReg Rn) { CompileInterpretInstruction(); } + +// Multiply (Dual) instructions +void JitX64::SMLAD(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMLALD(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMLSD(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMLSLD(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMUAD(Cond cond, ArmReg Rd, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SMUSD(Cond cond, ArmReg Rd, ArmReg Rm, bool M, ArmReg Rn) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/packing.cpp b/src/core/arm/jit_x64/instructions/packing.cpp new file mode 100644 index 000000000..2fb03a4c5 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/packing.cpp @@ -0,0 +1,12 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::PKHBT(Cond cond, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::PKHTB(Cond cond, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/parallel_add_subtract_halving.cpp b/src/core/arm/jit_x64/instructions/parallel_add_subtract_halving.cpp new file mode 100644 index 000000000..2c297e969 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/parallel_add_subtract_halving.cpp @@ -0,0 +1,22 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::SHADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SHADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SHASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SHSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SHSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SHSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UHADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UHADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UHASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UHSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UHSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UHSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/parallel_add_subtract_modulo.cpp b/src/core/arm/jit_x64/instructions/parallel_add_subtract_modulo.cpp new file mode 100644 index 000000000..b0bff730f --- /dev/null +++ b/src/core/arm/jit_x64/instructions/parallel_add_subtract_modulo.cpp @@ -0,0 +1,22 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::SADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::SSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::USAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::USUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::USUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/parallel_add_subtract_saturating.cpp b/src/core/arm/jit_x64/instructions/parallel_add_subtract_saturating.cpp new file mode 100644 index 000000000..77e5807c7 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/parallel_add_subtract_saturating.cpp @@ -0,0 +1,22 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::QADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UQADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UQADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UQASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UQSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UQSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::UQSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/qadd_qsub.cpp b/src/core/arm/jit_x64/instructions/qadd_qsub.cpp new file mode 100644 index 000000000..5084120b7 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/qadd_qsub.cpp @@ -0,0 +1,14 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::QADD(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QSUB(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QDADD(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::QDSUB(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/reversal.cpp b/src/core/arm/jit_x64/instructions/reversal.cpp new file mode 100644 index 000000000..f4928f1fb --- /dev/null +++ b/src/core/arm/jit_x64/instructions/reversal.cpp @@ -0,0 +1,13 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::REV(Cond cond, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::REV16(Cond cond, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } +void JitX64::REVSH(Cond cond, ArmReg Rd, ArmReg Rm) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/saturation.cpp b/src/core/arm/jit_x64/instructions/saturation.cpp new file mode 100644 index 000000000..be85879de --- /dev/null +++ b/src/core/arm/jit_x64/instructions/saturation.cpp @@ -0,0 +1,14 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::SSAT(Cond cond, ArmImm5 sat_imm, ArmReg Rd, ArmImm5 imm5, bool sh, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::SSAT16(Cond cond, ArmImm4 sat_imm, ArmReg Rd, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::USAT(Cond cond, ArmImm5 sat_imm, ArmReg Rd, ArmImm5 imm5, bool sh, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::USAT16(Cond cond, ArmImm4 sat_imm, ArmReg Rd, ArmReg Rn) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/status_register.cpp b/src/core/arm/jit_x64/instructions/status_register.cpp new file mode 100644 index 000000000..943b2e179 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/status_register.cpp @@ -0,0 +1,32 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +using namespace Gen; + +void JitX64::CPS() { CompileInterpretInstruction(); } +void JitX64::MRS() { CompileInterpretInstruction(); } +void JitX64::MSR() { CompileInterpretInstruction(); } +void JitX64::RFE() { CompileInterpretInstruction(); } + +void JitX64::SETEND(bool E) { + cond_manager.Always(); + + if (E) { + code->OR(32, MJitStateCpsr(), Imm32(1 << 9)); + current.EFlag = true; + } else { + code->AND(32, MJitStateCpsr(), Imm32(~(1 << 9))); + current.EFlag = false; + } + + current.arm_pc += GetInstSize(); +} + +void JitX64::SRS() { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/synchronisation.cpp b/src/core/arm/jit_x64/instructions/synchronisation.cpp new file mode 100644 index 000000000..6e4b7988b --- /dev/null +++ b/src/core/arm/jit_x64/instructions/synchronisation.cpp @@ -0,0 +1,297 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include + +#include "common/assert.h" +#include "common/x64/abi.h" + +#include "core/arm/jit_x64/jit_x64.h" +#include "core/arm/jit_x64/instructions/helper/load_store.h" + +namespace JitX64 { + +using namespace Gen; + +void JitX64::CLREX() { + cond_manager.Always(); + + code->MOV(32, MJitStateExclusiveTag(), Imm32(0xFFFFFFFF)); + code->MOV(8, MJitStateExclusiveState(), Imm8(0)); + + current.arm_pc += GetInstSize(); +} + +void ExclusiveLoadCommon(XEmitter* code, RegAlloc& reg_alloc, OpArg exclusive_state, OpArg exclusive_tag, ArmReg Rn_index, ArmReg Rd_index) { + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC, "UNPREDICTABLE"); + + code->MOV(8, exclusive_state, Imm8(1)); + + reg_alloc.FlushX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_PARAM1); + + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + code->MOV(32, R(ABI_PARAM1), Rn); + reg_alloc.UnlockArm(Rn_index); + + code->MOV(32, exclusive_tag, R(ABI_PARAM1)); + code->AND(32, exclusive_tag, Imm32(RESERVATION_GRANULE_MASK)); + + reg_alloc.UnlockX64(ABI_PARAM1); +} + +void JitX64::LDREX(Cond cond, ArmReg Rn_index, ArmReg Rd_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC, "UNPREDICTABLE"); + + ExclusiveLoadCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), Rn_index, Rd_index); + CompileCallHost(reinterpret_cast(!current.EFlag ? &Load32LE : &Load32BE)); + + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOV(32, R(Rd), R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDREXB(Cond cond, ArmReg Rn_index, ArmReg Rd_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC, "UNPREDICTABLE"); + + ExclusiveLoadCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), Rn_index, Rd_index); + CompileCallHost(reinterpret_cast(&Load8)); + + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVZX(32, 8, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDREXD(Cond cond, ArmReg Rn_index, ArmReg Rd_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(IsEvenArmReg(Rd_index), "UNPREDICTABLE"); + ASSERT_MSG(Rd_index < ArmReg::R14, "UNPREDICTABLE"); + ASSERT_MSG(Rn_index != ArmReg::PC, "UNPREDICTABLE"); + + ExclusiveLoadCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), Rn_index, Rd_index); + CompileCallHost(reinterpret_cast(!current.EFlag ? Load64LE : Load64BE)); + + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd0 = reg_alloc.BindArmForWrite(Rd_index + 0); + X64Reg Rd1 = reg_alloc.BindArmForWrite(Rd_index + 1); + code->MOV(64, R(Rd0), R(ABI_RETURN)); + code->SHR(64, R(ABI_RETURN), Imm8(32)); + code->MOV(32, R(Rd1), R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index + 0); + reg_alloc.UnlockArm(Rd_index + 1); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void JitX64::LDREXH(Cond cond, ArmReg Rn_index, ArmReg Rd_index) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC, "UNPREDICTABLE"); + + ExclusiveLoadCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), Rn_index, Rd_index); + CompileCallHost(reinterpret_cast(!current.EFlag ? Load16LE : Load16BE)); + + reg_alloc.LockX64(ABI_RETURN); + + X64Reg Rd = reg_alloc.BindArmForWrite(Rd_index); + code->MOVZX(32, 16, Rd, R(ABI_RETURN)); + reg_alloc.UnlockArm(Rd_index); + + reg_alloc.UnlockX64(ABI_RETURN); + + current.arm_pc += GetInstSize(); +} + +void ExclusiveStoreCommon(XEmitter* code, RegAlloc& reg_alloc, OpArg exclusive_state, OpArg exclusive_tag, ArmReg Rn_index, ArmReg Rd_index, std::function do_memory_access) { + OpArg Rn = reg_alloc.LockArmForRead(Rn_index); + OpArg Rd = reg_alloc.LockArmForWrite(Rd_index); + + code->MOV(32, Rd, Imm8(1)); // First, assume we failed. + + code->MOV(32, R(ABI_PARAM1), Rn); + + code->BT(8, exclusive_state, Imm8(0)); + auto jmp_to_end1 = code->J_CC(CC_NC); + + code->MOV(32, R(ABI_PARAM2), R(ABI_PARAM1)); + code->AND(32, R(ABI_PARAM2), Imm32(RESERVATION_GRANULE_MASK)); + code->CMP(32, R(ABI_PARAM2), exclusive_tag); + auto jmp_to_end2 = code->J_CC(CC_NE); + + // Exclsuive monitor pass + code->MOV(32, Rd, Imm8(0)); // Okay, actually we passed. + code->MOV(8, exclusive_state, Imm8(0)); // Unset exclusive memory acecss. + code->MOV(32, exclusive_tag, Imm32(0xFFFFFFFF)); // Unset exclusive memory acecss. + + do_memory_access(); + + code->SetJumpTarget(jmp_to_end1); + code->SetJumpTarget(jmp_to_end2); + + reg_alloc.UnlockArm(Rd_index); + reg_alloc.UnlockArm(Rn_index); +} + +void JitX64::STREX(Cond cond, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + CompileInterpretInstruction(); + return; + + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC && Rm_index != ArmReg::PC, "UNPREDICTABLE"); + ASSERT_MSG(Rd_index != Rn_index && Rd_index != Rm_index, "UNPREDICTABLE"); + + reg_alloc.FlushX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_PARAM1); + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + OpArg Rm = reg_alloc.LockArmForRead(Rm_index); + + ExclusiveStoreCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), + Rn_index, Rd_index, + [&](){ + code->MOV(32, R(ABI_PARAM2), Rm); + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store32LE : &Store32BE)); + }); + + reg_alloc.UnlockArm(Rm_index); + + reg_alloc.UnlockX64(ABI_PARAM2); + reg_alloc.UnlockX64(ABI_PARAM1); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STREXB(Cond cond, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + CompileInterpretInstruction(); + return; + + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC && Rm_index != ArmReg::PC, "UNPREDICTABLE"); + ASSERT_MSG(Rd_index != Rn_index && Rd_index != Rm_index, "UNPREDICTABLE"); + + reg_alloc.FlushX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_PARAM1); + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + OpArg Rm = reg_alloc.LockArmForRead(Rm_index); + + ExclusiveStoreCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), + Rn_index, Rd_index, + [&]() { + code->MOV(32, R(ABI_PARAM2), Rm); + CompileCallHost(reinterpret_cast(&Store8)); + }); + + reg_alloc.UnlockArm(Rm_index); + + reg_alloc.UnlockX64(ABI_PARAM2); + reg_alloc.UnlockX64(ABI_PARAM1); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STREXD(Cond cond, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + CompileInterpretInstruction(); + return; + + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC && Rm_index != ArmReg::PC, "UNPREDICTABLE"); + ASSERT_MSG(Rm_index != ArmReg::R14, "UNPREDICTABLE"); + ASSERT_MSG(Rd_index != Rn_index && Rd_index != Rm_index, "UNPREDICTABLE"); + ASSERT_MSG(Rd_index != Rm_index + 1, "UNPREDICTABLE"); + ASSERT_MSG(IsEvenArmReg(Rm_index), "UNPREDICTABLE"); + + reg_alloc.FlushX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_PARAM1); + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + reg_alloc.FlushX64(ABI_PARAM3); + reg_alloc.LockX64(ABI_PARAM3); + + OpArg Rm0 = reg_alloc.LockArmForRead(Rm_index + 0); + OpArg Rm1 = reg_alloc.LockArmForRead(Rm_index + 1); + + ExclusiveStoreCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), + Rn_index, Rd_index, + [&]() { + code->MOV(32, R(ABI_PARAM2), Rm0); + code->MOV(32, R(ABI_PARAM3), Rm1); + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store64LE : &Store64BE)); + }); + + reg_alloc.UnlockArm(Rm_index + 1); + reg_alloc.UnlockArm(Rm_index + 0); + + reg_alloc.UnlockX64(ABI_PARAM3); + reg_alloc.UnlockX64(ABI_PARAM2); + reg_alloc.UnlockX64(ABI_PARAM1); + + current.arm_pc += GetInstSize(); +} + +void JitX64::STREXH(Cond cond, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + CompileInterpretInstruction(); + return; + + cond_manager.CompileCond(cond); + + ASSERT_MSG(Rn_index != ArmReg::PC && Rd_index != ArmReg::PC && Rm_index != ArmReg::PC, "UNPREDICTABLE"); + ASSERT_MSG(Rd_index != Rn_index && Rd_index != Rm_index, "UNPREDICTABLE"); + + reg_alloc.FlushX64(ABI_PARAM1); + reg_alloc.LockX64(ABI_PARAM1); + reg_alloc.FlushX64(ABI_PARAM2); + reg_alloc.LockX64(ABI_PARAM2); + + OpArg Rm = reg_alloc.LockArmForRead(Rm_index); + + ExclusiveStoreCommon(code, reg_alloc, MJitStateExclusiveState(), MJitStateExclusiveTag(), + Rn_index, Rd_index, + [&]() { + code->MOV(32, R(ABI_PARAM2), Rm); + CompileCallHost(reinterpret_cast(!current.EFlag ? &Store16LE : &Store16BE)); + }); + + reg_alloc.UnlockArm(Rm_index); + + reg_alloc.UnlockX64(ABI_PARAM2); + reg_alloc.UnlockX64(ABI_PARAM1); + + current.arm_pc += GetInstSize(); +} + +void JitX64::SWP(Cond cond, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + CompileInterpretInstruction(); +} + +void JitX64::SWPB(Cond cond, ArmReg Rn_index, ArmReg Rd_index, ArmReg Rm_index) { + CompileInterpretInstruction(); +} + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/thumb.cpp b/src/core/arm/jit_x64/instructions/thumb.cpp new file mode 100644 index 000000000..7bb0be1c3 --- /dev/null +++ b/src/core/arm/jit_x64/instructions/thumb.cpp @@ -0,0 +1,100 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/assert.h" +#include "common/bit_util.h" + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +using namespace Gen; + +void JitX64::thumb_B(Cond cond, ArmImm8 imm8) { + cond_manager.CompileCond(cond); + + ASSERT_MSG(current.TFlag, "thumb_B may only be called in thumb mode"); + + const u32 new_pc = GetReg15Value() + BitUtil::SignExtend<9>(imm8 << 1); + + reg_alloc.FlushEverything(); + current.arm_pc += GetInstSize(); + CompileUpdateCycles(false); + CompileJumpToBB(new_pc); + + if (cond == Cond::AL) { + stop_compilation = true; + } +} + +void JitX64::thumb_B(ArmImm11 imm11) { + cond_manager.Always(); + + ASSERT_MSG(current.TFlag, "thumb_B may only be called in thumb mode"); + + const u32 new_pc = GetReg15Value() + BitUtil::SignExtend<12>(imm11 << 1); + + reg_alloc.FlushEverything(); + current.arm_pc += GetInstSize(); + CompileUpdateCycles(false); + CompileJumpToBB(new_pc); + + stop_compilation = true; +} + +void JitX64::thumb_BLX_prefix(ArmImm11 imm11) { + cond_manager.Always(); + + ASSERT_MSG(!thumb_BLX_prefix_executed, "two thumb BLX prefixes cannot occur in a row, pc = %u", current.arm_pc); + ASSERT_MSG(!thumb_BLX_suffix_executed, "thumb_BLX_prefix invalid state, pc = %u", current.arm_pc); + ASSERT_MSG(current.TFlag, "thumb_BLX_prefix should only be called in thumb mode, pc = %u", current.arm_pc); + + thumb_BLX_prefix_imm11 = imm11; + thumb_BLX_prefix_executed = true; + + current.arm_pc += GetInstSize(); + + // Compile the suffix, and make sure that it's compiled. + instructions_compiled++; // Has to be done to pass unit tests (same method of counting as interpreter). + CompileSingleThumbInstruction(); + ASSERT_MSG(thumb_BLX_suffix_executed, "thumb BLX suffix did not come after thumb BLX prefix, pc = %u", current.arm_pc); + + thumb_BLX_prefix_executed = false; + thumb_BLX_suffix_executed = false; +} + +void JitX64::thumb_BLX_suffix(bool X, ArmImm11 imm11) { + cond_manager.Always(); + + // Must only be ever called right after the prefix. + ASSERT_MSG(thumb_BLX_prefix_executed, "thumb BLX suffix may only come after a thumb BLX prefix, pc = %u", current.arm_pc); + ASSERT_MSG(!thumb_BLX_suffix_executed, "thumb_BLX_suffix invalid state, pc = %u", current.arm_pc); + ASSERT_MSG(current.TFlag, "thumb_BLX_suffix should only be called in thumb mode, pc = %u", current.arm_pc); + + u32 new_pc = (current.arm_pc + 2) + + BitUtil::SignExtend<23>(thumb_BLX_prefix_imm11 << 12) + + (imm11 << 1); + u32 new_lr = (current.arm_pc + 2) | 1; + + OpArg LR = reg_alloc.LockArmForWrite(ArmReg::LR); + code->MOV(32, LR, Imm32(new_lr)); + reg_alloc.UnlockArm(ArmReg::LR); + + if (X) { + current.TFlag = false; + code->MOV(32, MJitStateTFlag(), Imm32(0)); + new_pc &= 0xFFFFFFFC; + } + + reg_alloc.FlushEverything(); + current.arm_pc += GetInstSize(); + CompileUpdateCycles(); + CompileJumpToBB(new_pc); + + stop_compilation = true; + + thumb_BLX_suffix_executed = true; +} + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/instructions/usad.cpp b/src/core/arm/jit_x64/instructions/usad.cpp new file mode 100644 index 000000000..1f904c08c --- /dev/null +++ b/src/core/arm/jit_x64/instructions/usad.cpp @@ -0,0 +1,12 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/jit_x64/jit_x64.h" + +namespace JitX64 { + +void JitX64::USAD8(Cond cond, ArmReg Rd, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } +void JitX64::USADA8(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, ArmReg Rn) { CompileInterpretInstruction(); } + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/interface.cpp b/src/core/arm/jit_x64/interface.cpp new file mode 100644 index 000000000..2ffb24570 --- /dev/null +++ b/src/core/arm/jit_x64/interface.cpp @@ -0,0 +1,238 @@ + +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include + +#include "common/assert.h" +#include "common/x64/abi.h" +#include "common/x64/emitter.h" + +#include "core/arm/jit_x64/common.h" +#include "core/arm/jit_x64/interface.h" +#include "core/arm/jit_x64/jit_x64.h" +#include "core/core.h" +#include "core/core_timing.h" + +namespace Gen { + +struct RunJittedCode final : private Gen::XCodeBlock { +private: + using RunJitFuncType = void(*)(JitX64::JitState*, void*); + RunJitFuncType run_jit; + u64 return_from_run_jit; + +public: + RunJittedCode() { + AllocCodeSpace(1024); + + run_jit = RunJitFuncType(this->GetCodePtr()); + + // This serves two purposes: + // 1. It saves all the registers we as a callee need to save. + // 2. It aligns the stack so that the code the JIT emits can assume + // that the stack is appropriately aligned for CALLs. + ABI_PushRegistersAndAdjustStack(ABI_ALL_CALLEE_SAVED, 8); + + MOV(64, MDisp(ABI_PARAM1, offsetof(JitX64::JitState, save_host_RSP)), R(RSP)); + MOV(64, R(R15), R(ABI_PARAM1)); + + JMPptr(R(ABI_PARAM2)); + return_from_run_jit = reinterpret_cast(this->GetCodePtr()); + + MOV(64, R(RSP), MDisp(R15, offsetof(JitX64::JitState, save_host_RSP))); + ABI_PopRegistersAndAdjustStack(ABI_ALL_CALLEE_SAVED, 8); + RET(); + } + + unsigned CallCode(JitX64::JitState* jit_state, void* bb, unsigned cycles_to_run, u32& new_pc) { + auto cpu = &jit_state->cpu_state; + + cpu->NFlag = (cpu->Cpsr >> 31); + cpu->ZFlag = (cpu->Cpsr >> 30) & 1; + cpu->CFlag = (cpu->Cpsr >> 29) & 1; + cpu->VFlag = (cpu->Cpsr >> 28) & 1; + cpu->TFlag = (cpu->Cpsr >> 5) & 1; + + jit_state->cycles_remaining = cycles_to_run; + jit_state->return_RIP = CallCodeReturnAddress(); + + run_jit(jit_state, bb); + + new_pc = cpu->Reg[15]; + + cpu->Cpsr = (cpu->Cpsr & 0x0fffffdf) | + (cpu->NFlag << 31) | + (cpu->ZFlag << 30) | + (cpu->CFlag << 29) | + (cpu->VFlag << 28) | + (cpu->TFlag << 5); + + return cycles_to_run - jit_state->cycles_remaining; + } + + u64 CallCodeReturnAddress() const { + return return_from_run_jit; + } +}; + +struct BlockOfCode : Gen::XCodeBlock { + BlockOfCode() { + AllocCodeSpace(128 * 1024 * 1024); + } +}; + +} + +namespace JitX64 { + +struct ARM_Jit::Impl { + Gen::RunJittedCode run_jit = {}; + Gen::BlockOfCode block_of_code = {}; + JitX64 compiler{ &block_of_code }; +}; + +ARM_Jit::ARM_Jit(PrivilegeMode initial_mode) : impl(std::make_unique()), state(std::make_unique()) { + ASSERT_MSG(initial_mode == PrivilegeMode::USER32MODE, "Unimplemented"); + ClearCache(); +} + +ARM_Jit::~ARM_Jit() { +} + +void ARM_Jit::SetPC(u32 pc) { + state->cpu_state.Reg[15] = pc; +} + +u32 ARM_Jit::GetPC() const { + return state->cpu_state.Reg[15]; +} + +u32 ARM_Jit::GetReg(int index) const { + if (index == 15) return GetPC(); + return state->cpu_state.Reg[index]; +} + +void ARM_Jit::SetReg(int index, u32 value) { + if (index == 15) return SetPC(value); + state->cpu_state.Reg[index] = value; +} + +u32 ARM_Jit::GetVFPReg(int index) const { + return state->cpu_state.ExtReg[index]; +} + +void ARM_Jit::SetVFPReg(int index, u32 value) { + state->cpu_state.ExtReg[index] = value; +} + +u32 ARM_Jit::GetVFPSystemReg(VFPSystemRegister reg) const { + return state->cpu_state.VFP[reg]; +} + +void ARM_Jit::SetVFPSystemReg(VFPSystemRegister reg, u32 value) { + state->cpu_state.VFP[reg] = value; +} + +u32 ARM_Jit::GetCPSR() const { + return state->cpu_state.Cpsr; +} + +void ARM_Jit::SetCPSR(u32 cpsr) { + state->cpu_state.Cpsr = cpsr; +} + +u32 ARM_Jit::GetCP15Register(CP15Register reg) { + return state->cpu_state.CP15[reg]; +} + +void ARM_Jit::SetCP15Register(CP15Register reg, u32 value) { + state->cpu_state.CP15[reg] = value; +} + +void ARM_Jit::AddTicks(u64 ticks) { + down_count -= ticks; + if (down_count < 0) + CoreTiming::Advance(); +} + +void ARM_Jit::ExecuteInstructions(int num_instructions) { + reschedule = false; + + do { + bool EFlag = (state->cpu_state.Cpsr >> 9) & 1; + state->cpu_state.TFlag = (state->cpu_state.Cpsr >> 5) & 1; + + if (!state->cpu_state.NirqSig) { + UNIMPLEMENTED(); + } + + if (state->cpu_state.TFlag) + state->cpu_state.Reg[15] &= 0xfffffffe; + else + state->cpu_state.Reg[15] &= 0xfffffffc; + + u8* ptr = impl->compiler.GetBB(state->cpu_state.Reg[15], state->cpu_state.TFlag, EFlag); + + unsigned ticks_executed = impl->run_jit.CallCode(state.get(), ptr, num_instructions, state->cpu_state.Reg[15]); + num_instructions -= ticks_executed; + AddTicks(ticks_executed); + } while (!reschedule && num_instructions > 0); +} + +void ARM_Jit::ResetContext(Core::ThreadContext& context, u32 stack_top, u32 entry_point, u32 arg) { + memset(&context, 0, sizeof(Core::ThreadContext)); + + context.cpu_registers[0] = arg; + context.pc = entry_point; + context.sp = stack_top; + context.cpsr = 0x1F; // Usermode +} + +void ARM_Jit::SaveContext(Core::ThreadContext& ctx) { + memcpy(ctx.cpu_registers, state->cpu_state.Reg.data(), sizeof(ctx.cpu_registers)); + memcpy(ctx.fpu_registers, state->cpu_state.ExtReg.data(), sizeof(ctx.fpu_registers)); + + ctx.sp = state->cpu_state.Reg[13]; + ctx.lr = state->cpu_state.Reg[14]; + ctx.pc = state->cpu_state.Reg[15]; + + ctx.cpsr = GetCPSR(); + + ctx.fpscr = state->cpu_state.VFP[1]; + ctx.fpexc = state->cpu_state.VFP[2]; +} + +void ARM_Jit::LoadContext(const Core::ThreadContext& ctx) { + memcpy(state->cpu_state.Reg.data(), ctx.cpu_registers, sizeof(ctx.cpu_registers)); + memcpy(state->cpu_state.ExtReg.data(), ctx.fpu_registers, sizeof(ctx.fpu_registers)); + + state->cpu_state.Reg[13] = ctx.sp; + state->cpu_state.Reg[14] = ctx.lr; + state->cpu_state.Reg[15] = ctx.pc; + SetCPSR(ctx.cpsr); + + state->cpu_state.VFP[1] = ctx.fpscr; + state->cpu_state.VFP[2] = ctx.fpexc; +} + +void ARM_Jit::PrepareReschedule() { + reschedule = true; + state->cpu_state.NumInstrsToExecute = 0; +} + +void ARM_Jit::ClearCache() { + impl->compiler.ClearCache(); + impl->block_of_code.ClearCodeSpace(); + state->cpu_state.instruction_cache.clear(); +} + +void ARM_Jit::FastClearCache() { + impl->compiler.ClearCache(); + impl->block_of_code.ResetCodePtr(); + state->cpu_state.instruction_cache.clear(); +} + +} diff --git a/src/core/arm/jit_x64/interface.h b/src/core/arm/jit_x64/interface.h new file mode 100644 index 000000000..deba96a9a --- /dev/null +++ b/src/core/arm/jit_x64/interface.h @@ -0,0 +1,54 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include + +#include "common/common_types.h" + +#include "core/arm/arm_interface.h" +#include "core/arm/jit_x64/common.h" + +namespace JitX64 { + +class ARM_Jit final : virtual public ARM_Interface { +public: + ARM_Jit(PrivilegeMode initial_mode); + ~ARM_Jit(); + + void SetPC(u32 pc) override; + u32 GetPC() const override; + u32 GetReg(int index) const override; + void SetReg(int index, u32 value) override; + u32 GetVFPReg(int index) const override; + void SetVFPReg(int index, u32 value) override; + u32 GetVFPSystemReg(VFPSystemRegister reg) const override; + void SetVFPSystemReg(VFPSystemRegister reg, u32 value) override; + u32 GetCPSR() const override; + void SetCPSR(u32 cpsr) override; + u32 GetCP15Register(CP15Register reg) override; + void SetCP15Register(CP15Register reg, u32 value) override; + + void AddTicks(u64 ticks) override; + + void ResetContext(Core::ThreadContext& context, u32 stack_top, u32 entry_point, u32 arg) override; + void SaveContext(Core::ThreadContext& ctx) override; + void LoadContext(const Core::ThreadContext& ctx) override; + + void PrepareReschedule() override; + void ExecuteInstructions(int num_instructions) override; + + void ClearCache() override; + void FastClearCache(); + +private: + struct Impl; + + std::unique_ptr impl; + bool reschedule = false; + std::unique_ptr state; +}; + +} diff --git a/src/core/arm/jit_x64/interpret.cpp b/src/core/arm/jit_x64/interpret.cpp new file mode 100644 index 000000000..554da3f13 --- /dev/null +++ b/src/core/arm/jit_x64/interpret.cpp @@ -0,0 +1,63 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "common/x64/abi.h" + +#include "core/arm/jit_x64/jit_x64.h" + +extern unsigned InterpreterMainLoop(ARMul_State* cpu); + +namespace JitX64 { + +using namespace Gen; + +static JitState* CallInterpreter(JitState* jit_state, u64 pc, u64 TFlag, u64 EFlag) { + ARMul_State* cpu = &jit_state->cpu_state; + + cpu->Reg[15] = pc; + + cpu->Cpsr = (cpu->Cpsr & 0x0fffffdf) | + (cpu->NFlag << 31) | + (cpu->ZFlag << 30) | + (cpu->CFlag << 29) | + (cpu->VFlag << 28) | + (cpu->TFlag << 5); + + if (jit_state->cycles_remaining >= 0) { +#if 0 + cpu->NumInstrsToExecute = jit_state->cycles_remaining + 1; + if (cpu->NumInstrsToExecute > 100) cpu->NumInstrsToExecute = 100; + jit_state->cycles_remaining -= InterpreterMainLoop(cpu) - 1; +#else + cpu->NumInstrsToExecute = 1; + jit_state->cycles_remaining -= InterpreterMainLoop(cpu) - 1; +#endif + } + + return jit_state; +} + +void JitX64::CompileInterpretInstruction() { + cond_manager.Always(); + reg_alloc.FlushEverything(); + + CompileUpdateCycles(); + + code->MOV(64, R(ABI_PARAM1), R(reg_alloc.JitStateReg())); + code->MOV(64, R(ABI_PARAM2), Imm64(current.arm_pc)); + code->MOV(64, R(ABI_PARAM3), Imm64(current.TFlag)); + code->MOV(64, R(ABI_PARAM4), Imm64(current.EFlag)); + + CompileCallHost(reinterpret_cast(&CallInterpreter)); + + code->MOV(64, R(reg_alloc.JitStateReg()), R(ABI_RETURN)); + + // Return to dispatch + code->JMPptr(MJitStateHostReturnRIP()); + + current.arm_pc += GetInstSize(); + stop_compilation = true; +} + +} diff --git a/src/core/arm/jit_x64/jit_x64.cpp b/src/core/arm/jit_x64/jit_x64.cpp new file mode 100644 index 000000000..110fc312a --- /dev/null +++ b/src/core/arm/jit_x64/jit_x64.cpp @@ -0,0 +1,265 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include "core/arm/dyncom/arm_dyncom_interpreter.h" +#include "core/arm/jit_x64/jit_x64.h" +#include "core/memory.h" + +namespace JitX64 { + +using namespace Gen; + +JitX64::JitX64(XEmitter* code) : code(code) {} + +void JitX64::ClearCache() { + basic_blocks.clear(); + patch_jmp_locations.clear(); + InterpreterClearCache(); +} + +CodePtr JitX64::GetBB(u32 pc, bool TFlag, bool EFlag) { + const LocationDescriptor desc = { pc, TFlag, EFlag }; + + if (basic_blocks.find(desc) == basic_blocks.end()) { + return Compile(pc, TFlag, EFlag); + } + + return basic_blocks[desc]; +} + +CodePtr JitX64::Compile(u32 pc, bool TFlag, bool EFlag) { + const CodePtr bb = code->GetWritableCodePtr(); + const LocationDescriptor desc = { pc, TFlag, EFlag }; + ASSERT(basic_blocks.find(desc) == basic_blocks.end()); + basic_blocks[desc] = bb; + Patch(desc, bb); + + reg_alloc.Init(code); + cond_manager.Init(this); + current = desc; + instructions_compiled = 0; + stop_compilation = false; + + do { + instructions_compiled++; + + if (current.TFlag) { + CompileSingleThumbInstruction(); + } else { + CompileSingleArmInstruction(); + } + + reg_alloc.AssertNoLocked(); + } while (!stop_compilation && ((current.arm_pc & 0xFFF) != 0)); + + if (!stop_compilation) { + // We're stopping compilation because we've reached a page boundary. + cond_manager.Always(); + CompileUpdateCycles(); + CompileJumpToBB(current.arm_pc); + } + + // Insert easily searchable byte sequence for ease of lookup in memory dumps. + code->NOP(); + code->INT3(); + code->NOP(); + + return bb; +} + +void JitX64::CompileUpdateCycles(bool reset_cycles) { + // We're just taking one instruction == one cycle. + if (instructions_compiled) { + code->SUB(32, MJitStateCycleCount(), Imm32(instructions_compiled)); + } + if (reset_cycles) { + instructions_compiled = 0; + } +} + +void JitX64::CompileReturnToDispatch() { + if (cond_manager.CurrentCond() == Cond::AL) { + reg_alloc.FlushEverything(); + CompileUpdateCycles(); + code->JMPptr(MJitStateHostReturnRIP()); + + stop_compilation = true; + return; + } + + reg_alloc.FlushEverything(); + CompileUpdateCycles(false); + code->JMPptr(MJitStateHostReturnRIP()); + + cond_manager.Always(); + CompileUpdateCycles(true); + CompileJumpToBB(current.arm_pc); + code->MOV(32, MJitStateArmPC(), Imm32(current.arm_pc)); + code->JMPptr(MJitStateHostReturnRIP()); + + stop_compilation = true; + return; +} + +void JitX64::CompileJumpToBB(u32 new_pc) { + reg_alloc.FlushEverything(); + code->CMP(32, MJitStateCycleCount(), Imm8(0)); + + const LocationDescriptor new_desc = { new_pc, current.TFlag, current.EFlag }; + patch_jmp_locations[new_desc].emplace_back(code->GetWritableCodePtr()); + if (basic_blocks.find(new_desc) == basic_blocks.end()) { + code->NOP(6); // Leave enough space for a jg instruction. + } else { + code->J_CC(CC_G, basic_blocks[new_desc], true); + } + + code->MOV(32, MJitStateArmPC(), Imm32(new_pc)); + code->JMPptr(MJitStateHostReturnRIP()); +} + +void JitX64::Patch(LocationDescriptor desc, CodePtr bb) { + const CodePtr save_code_ptr = code->GetWritableCodePtr(); + + for (CodePtr location : patch_jmp_locations[desc]) { + code->SetCodePtr(location); + code->J_CC(CC_G, bb, true); + ASSERT(code->GetCodePtr() - location == 6); + } + + code->SetCodePtr(save_code_ptr); +} + +void JitX64::CompileSingleArmInstruction() { + u32 inst = Memory::Read32(current.arm_pc & 0xFFFFFFFC); + + auto inst_info = ArmDecoder::DecodeArm(inst); + if (!inst_info) { + // TODO: Log message + CompileInterpretInstruction(); + } else { + inst_info->Visit(this, inst); + } +} + +void JitX64::CompileSingleThumbInstruction() { + u32 inst_u32 = Memory::Read32(current.arm_pc & 0xFFFFFFFC); + if ((current.arm_pc & 0x2) != 0) { + inst_u32 >>= 16; + } + inst_u32 &= 0xFFFFF; + u16 inst = inst_u32; + + auto inst_info = ArmDecoder::DecodeThumb(inst); + if (!inst_info) { + // TODO: Log message + CompileInterpretInstruction(); + } else { + inst_info->Visit(this, inst); + } +} + +void JitX64::CompileCallHost(const void* const fn) { + // There is no need to setup the stack as the stored RSP has already been properly aligned. + + reg_alloc.FlushABICallerSaved(); + + ASSERT(reg_alloc.JitStateReg() != RSP); + code->MOV(64, R(RSP), MJitStateHostReturnRSP()); + + const uintptr_t distance = reinterpret_cast(fn) - (reinterpret_cast(code->GetCodePtr()) + 5); + if (distance >= 0x0000000080000000ULL && distance < 0xFFFFFFFF80000000ULL) { + // Far call + code->MOV(64, R(RAX), ImmPtr(fn)); + code->CALLptr(R(RAX)); + } else { + code->CALL(fn); + } +} + +// Convenience functions: +// We static_assert types because anything that calls these functions makes those assumptions. +// If the types of the variables are changed please update all code that calls these functions. + +Gen::OpArg JitX64::MJitStateCycleCount() const { + static_assert(std::is_same::value, "JitState::cycles_remaining must be s32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cycles_remaining)); +} + +Gen::OpArg JitX64::MJitStateArmPC() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same>::value, "ARMul_State::Reg must be std::array"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, Reg) + 15 * sizeof(u32)); +} + +Gen::OpArg JitX64::MJitStateTFlag() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "TFlag must be u32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, TFlag)); +} + +Gen::OpArg JitX64::MJitStateHostReturnRIP() const { + static_assert(std::is_same::value, "JitState::return_RIP must be u64"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, return_RIP)); +} + +Gen::OpArg JitX64::MJitStateHostReturnRSP() const { + static_assert(std::is_same::value, "JitState::save_host_RSP must be u64"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, save_host_RSP)); +} + +Gen::OpArg JitX64::MJitStateZFlag() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "ZFlag must be u32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, ZFlag)); +} + +Gen::OpArg JitX64::MJitStateCFlag() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "CFlag must be u32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, CFlag)); +} + +Gen::OpArg JitX64::MJitStateNFlag() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "NFlag must be u32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, NFlag)); +} + +Gen::OpArg JitX64::MJitStateVFlag() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "VFlag must be u32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, VFlag)); +} + +Gen::OpArg JitX64::MJitStateCpsr() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "Cpsr must be u32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, Cpsr)); +} + +Gen::OpArg JitX64::MJitStateExclusiveTag() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "exclusive_tag must be u32"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, exclusive_tag)); +} + +Gen::OpArg JitX64::MJitStateExclusiveState() const { + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same::value, "exclusive_state must be bool"); + + return Gen::MDisp(reg_alloc.JitStateReg(), offsetof(JitState, cpu_state) + offsetof(ARMul_State, exclusive_state)); +} + +} diff --git a/src/core/arm/jit_x64/jit_x64.h b/src/core/arm/jit_x64/jit_x64.h new file mode 100644 index 000000000..96f06f8cb --- /dev/null +++ b/src/core/arm/jit_x64/jit_x64.h @@ -0,0 +1,432 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +#include "common/common_types.h" +#include "common/x64/emitter.h" + +#include "core/arm/decoder/decoder.h" +#include "core/arm/jit_x64/common.h" +#include "core/arm/jit_x64/reg_alloc.h" + +namespace JitX64 { + +using CodePtr = u8*; + +struct LocationDescriptor { + LocationDescriptor() = delete; + LocationDescriptor(u32 arm_pc, bool TFlag, bool EFlag) : arm_pc(arm_pc), TFlag(TFlag), EFlag(EFlag) {} + u32 arm_pc; + bool TFlag; ///< Thumb / ARM + bool EFlag; ///< Big / Little Endian + + bool operator == (const LocationDescriptor& o) const { + return std::tie(arm_pc, TFlag, EFlag) == std::tie(o.arm_pc, o.TFlag, o.EFlag); + } +}; + +struct LocationDescriptorHash { + size_t operator()(const LocationDescriptor& x) const { + return std::hash()(static_cast(x.arm_pc) ^ (static_cast(x.TFlag) << 32) ^ (static_cast(x.EFlag) << 33)); + } +}; + +class JitX64 final : private ArmDecoder::Visitor { +public: + JitX64() = delete; + explicit JitX64(Gen::XEmitter* code); + ~JitX64() override {} + + void ClearCache(); + + CodePtr GetBB(u32 pc, bool TFlag, bool EFlag); + + /// Returns a pointer to the compiled basic block. + CodePtr Compile(u32 pc, bool TFlag, bool EFlag); + +private: + Gen::XEmitter* code = nullptr; + + RegAlloc reg_alloc; + + /// ARM pc -> x64 code block + std::unordered_map basic_blocks; + +private: + LocationDescriptor current = { 0, false, false }; + unsigned instructions_compiled = 0; + bool stop_compilation = false; + + size_t GetInstSize() const { return current.TFlag ? 2 : 4; } + void CompileSingleArmInstruction(); + void CompileSingleThumbInstruction(); + + /// Updates the cycle count in JitState and sets instructions_compiled to zero. + void CompileUpdateCycles(bool reset_cycles = true); + + /// Update MJitStateArmPC and current.TFlag before calling this function. + void CompileReturnToDispatch(); + + /// If a basic_block starting at ARM pc is compiled -> these locations need to be patched + std::unordered_map, LocationDescriptorHash> patch_jmp_locations; + /// Update JitState cycle count before calling this function. This function may instead update JitState PC and return to dispatcher. + void CompileJumpToBB(u32 arm_pc); + /// Patch missing jumps (fill in after CompileJumpToBB). + void Patch(LocationDescriptor desc, CodePtr bb); + +private: + /// Convenience functions + + Gen::OpArg MJitStateCycleCount() const; + Gen::OpArg MJitStateArmPC() const; + Gen::OpArg MJitStateTFlag() const; + Gen::OpArg MJitStateHostReturnRIP() const; + Gen::OpArg MJitStateHostReturnRSP() const; + Gen::OpArg MJitStateZFlag() const; + Gen::OpArg MJitStateCFlag() const; + Gen::OpArg MJitStateNFlag() const; + Gen::OpArg MJitStateVFlag() const; + Gen::OpArg MJitStateCpsr() const; + Gen::OpArg MJitStateExclusiveTag() const; + Gen::OpArg MJitStateExclusiveState() const; + + u32 GetReg15Value() const { + return (current.arm_pc & ~0x1) + static_cast(GetInstSize() * 2); + } + u32 GetReg15Value_WordAligned() const { + return (current.arm_pc & ~0x3) + static_cast(GetInstSize() * 2); + } + + void UpdateFlagsNZCV() { + cond_manager.FlagsDirty(); + code->SETcc(Gen::CC_S, MJitStateNFlag()); + code->SETcc(Gen::CC_Z, MJitStateZFlag()); + code->SETcc(Gen::CC_C, MJitStateCFlag()); + code->SETcc(Gen::CC_O, MJitStateVFlag()); + } + + void UpdateFlagsNZV() { + cond_manager.FlagsDirty(); + code->SETcc(Gen::CC_S, MJitStateNFlag()); + code->SETcc(Gen::CC_Z, MJitStateZFlag()); + code->SETcc(Gen::CC_O, MJitStateVFlag()); + } + + void UpdateFlagsNZ() { + cond_manager.FlagsDirty(); + code->SETcc(Gen::CC_S, MJitStateNFlag()); + code->SETcc(Gen::CC_Z, MJitStateZFlag()); + } + + void UpdateFlagsC_complement() { + cond_manager.FlagsDirty(); + code->SETcc(Gen::CC_NC, MJitStateCFlag()); + } + +private: + struct CondManager { + private: + JitX64* jit = nullptr; + Cond current_cond = Cond::AL; + bool flags_dirty = true; + Gen::FixupBranch current_cond_fixup = {}; + public: + void Init(JitX64* jit_); + void CompileCond(Cond cond); + void Always(); + void FlagsDirty(); + Cond CurrentCond() const; + } cond_manager; + +private: + void CompileInterpretInstruction(); + void CompileCallHost(const void* const fn); + /// dest must be a temporary that contains a copy of the value of Rm + void CompileShifter_imm(Gen::X64Reg dest, ArmImm5 imm5, ShiftType shift, bool do_shifter_carry_out); + + // Branch instructions + void B(Cond cond, ArmImm24 imm24) override; + void BL(Cond cond, ArmImm24 imm24) override; + void BLX_imm(bool H, ArmImm24 imm24) override; + void BLX_reg(Cond cond, ArmReg Rm) override; + void BX(Cond cond, ArmReg Rm) override; + void BXJ(Cond cond, ArmReg Rm) override; + + // Coprocessor instructions + void CDP() override; + void LDC() override; + void MCR() override; + void MCRR() override; + void MRC() override; + void MRRC() override; + void STC() override; + + // Data processing instructions + void CompileDataProcessingHelper(ArmReg Rn, ArmReg Rd, std::function body); + void CompileDataProcessingHelper_Reverse(ArmReg Rn, ArmReg Rd, std::function body); + Gen::X64Reg CompileDataProcessingHelper_reg(ArmImm5 imm5, ShiftType shift, ArmReg Rm, bool do_shifter_carry_out); + Gen::X64Reg CompileDataProcessingHelper_rsr(ArmReg Rs, ShiftType shift, ArmReg Rm, bool do_shifter_carry_out); + void ADC_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void ADC_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void ADC_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void ADD_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void ADD_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void ADD_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void AND_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void AND_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void AND_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void BIC_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void BIC_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void BIC_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void CMN_imm(Cond cond, ArmReg Rn, int rotate, ArmImm8 imm8) override; + void CMN_reg(Cond cond, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void CMN_rsr(Cond cond, ArmReg Rn, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void CMP_imm(Cond cond, ArmReg Rn, int rotate, ArmImm8 imm8) override; + void CMP_reg(Cond cond, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void CMP_rsr(Cond cond, ArmReg Rn, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void EOR_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void EOR_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void EOR_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void MOV_imm(Cond cond, bool S, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void MOV_reg(Cond cond, bool S, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void MOV_rsr(Cond cond, bool S, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void MVN_imm(Cond cond, bool S, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void MVN_reg(Cond cond, bool S, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void MVN_rsr(Cond cond, bool S, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void ORR_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void ORR_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void ORR_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void RSB_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void RSB_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void RSB_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void RSC_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void RSC_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void RSC_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void SBC_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void SBC_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void SBC_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void SUB_imm(Cond cond, bool S, ArmReg Rn, ArmReg Rd, int rotate, ArmImm8 imm8) override; + void SUB_reg(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void SUB_rsr(Cond cond, bool S, ArmReg Rn, ArmReg Rd, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void TEQ_imm(Cond cond, ArmReg Rn, int rotate, ArmImm8 imm8) override; + void TEQ_reg(Cond cond, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void TEQ_rsr(Cond cond, ArmReg Rn, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + void TST_imm(Cond cond, ArmReg Rn, int rotate, ArmImm8 imm8) override; + void TST_reg(Cond cond, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void TST_rsr(Cond cond, ArmReg Rn, ArmReg Rs, ShiftType shift, ArmReg Rm) override; + + // Exception generation instructions + void BKPT(Cond cond, ArmImm12 imm12, ArmImm4 imm4) override; + void SVC(Cond cond, ArmImm24 imm24) override; + void UDF() override; + + // Extension functions + void SXTAB(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void SXTAB16(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void SXTAH(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void SXTB(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void SXTB16(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void SXTH(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void UXTAB(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void UXTAB16(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void UXTAH(Cond cond, ArmReg Rn, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void UXTB(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void UXTB16(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + void UXTH(Cond cond, ArmReg Rd, SignExtendRotation rotate, ArmReg Rm) override; + + // Hint instructions + void PLD() override; + void SEV() override; + void WFE() override; + void WFI() override; + void YIELD() override; + + // Load/Store instructions + void LoadAndStoreWordOrUnsignedByte_Immediate_Helper(Gen::X64Reg dest, bool U, ArmReg Rn, ArmImm12 imm12); + void LoadAndStoreWordOrUnsignedByte_Register_Helper(Gen::X64Reg dest, bool U, ArmReg Rn, ArmReg Rm); + void LoadAndStoreWordOrUnsignedByte_ScaledRegister_Helper(Gen::X64Reg dest, bool U, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm); + void LoadAndStoreWordOrUnsignedByte_ImmediateOffset(Gen::X64Reg dest, bool U, ArmReg Rn, ArmImm12 imm12); + void LoadAndStoreWordOrUnsignedByte_ImmediatePreIndexed(Gen::X64Reg dest, bool U, ArmReg Rn_index, ArmImm12 imm12); + void LoadAndStoreWordOrUnsignedByte_ImmediatePostIndexed(Gen::X64Reg dest, bool U, ArmReg Rn_index, ArmImm12 imm12); + void LoadAndStoreWordOrUnsignedByte_ScaledRegisterOffset(Gen::X64Reg dest, bool U, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm); + void LoadAndStoreWordOrUnsignedByte_ScaledRegisterPreIndexed(Gen::X64Reg dest, bool U, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm); + void LoadAndStoreWordOrUnsignedByte_ScaledRegisterPostIndexed(Gen::X64Reg dest, bool U, ArmReg Rn, ArmImm5 imm5, ShiftType shift, ArmReg Rm); + void LDR_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm11 imm11) override; + void LDR_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void LDRB_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm11 imm11) override; + void LDRB_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void LDRBT() override; + void LDRD_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm4 imm8a, ArmImm4 imm8b) override; + void LDRD_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void LDRH_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm4 imm8a, ArmImm4 imm8b) override; + void LDRH_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void LDRHT() override; + void LDRSB_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm4 imm8a, ArmImm4 imm8b) override; + void LDRSB_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void LDRSBT() override; + void LDRSH_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm4 imm8a, ArmImm4 imm8b) override; + void LDRSH_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void LDRSHT() override; + void LDRT() override; + void STR_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm11 imm11) override; + void STR_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void STRB_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm11 imm11) override; + void STRB_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ShiftType shift, ArmReg Rm) override; + void STRBT() override; + void STRD_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm4 imm8a, ArmImm4 imm8b) override; + void STRD_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void STRH_imm(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmImm4 imm8a, ArmImm4 imm8b) override; + void STRH_reg(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void STRHT() override; + void STRT() override; + + // Load/Store multiple instructions + void LDM(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmRegList list) override; + void LDM_usr() override; + void LDM_eret() override; + void STM(Cond cond, bool P, bool U, bool W, ArmReg Rn, ArmRegList list) override; + void STM_usr() override; + + // Miscellaneous instructions + void CLZ(Cond cond, ArmReg Rd, ArmReg Rm) override; + void NOP() override; + void SEL(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + + // Unsigned sum of absolute difference functions + void USAD8(Cond cond, ArmReg Rd, ArmReg Rm, ArmReg Rn) override; + void USADA8(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, ArmReg Rn) override; + + // Packing instructions + void PKHBT(Cond cond, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ArmReg Rm) override; + void PKHTB(Cond cond, ArmReg Rn, ArmReg Rd, ArmImm5 imm5, ArmReg Rm) override; + + // Reversal instructions + void REV(Cond cond, ArmReg Rd, ArmReg Rm) override; + void REV16(Cond cond, ArmReg Rd, ArmReg Rm) override; + void REVSH(Cond cond, ArmReg Rd, ArmReg Rm) override; + + // Saturation instructions + void SSAT(Cond cond, ArmImm5 sat_imm, ArmReg Rd, ArmImm5 imm5, bool sh, ArmReg Rn) override; + void SSAT16(Cond cond, ArmImm4 sat_imm, ArmReg Rd, ArmReg Rn) override; + void USAT(Cond cond, ArmImm5 sat_imm, ArmReg Rd, ArmImm5 imm5, bool sh, ArmReg Rn) override; + void USAT16(Cond cond, ArmImm4 sat_imm, ArmReg Rd, ArmReg Rn) override; + + // Multiply (Normal) instructions + void MLA(Cond cond, bool S, ArmReg Rd, ArmReg Ra, ArmReg Rm, ArmReg Rn) override; + void MUL(Cond cond, bool S, ArmReg Rd, ArmReg Rm, ArmReg Rn) override; + + // Multiply (Long) instructions + void SMLAL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) override; + void SMULL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) override; + void UMAAL(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) override; + void UMLAL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) override; + void UMULL(Cond cond, bool S, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, ArmReg Rn) override; + + // Multiply (Halfword) instructions + void SMLALxy(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, bool M, bool N, ArmReg Rn) override; + void SMLAxy(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, bool N, ArmReg Rn) override; + void SMULxy(Cond cond, ArmReg Rd, ArmReg Rm, bool M, bool N, ArmReg Rn) override; + + // Multiply (word by halfword) instructions + void SMLAWy(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, ArmReg Rn) override; + void SMULWy(Cond cond, ArmReg Rd, ArmReg Rm, bool M, ArmReg Rn) override; + + // Multiply (Most significant word) instructions + void SMMLA(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool R, ArmReg Rn) override; + void SMMLS(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool R, ArmReg Rn) override; + void SMMUL(Cond cond, ArmReg Rd, ArmReg Rm, bool R, ArmReg Rn) override; + + // Multiply (Dual) instructions + void SMLAD(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, ArmReg Rn) override; + void SMLALD(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, bool M, ArmReg Rn) override; + void SMLSD(Cond cond, ArmReg Rd, ArmReg Ra, ArmReg Rm, bool M, ArmReg Rn) override; + void SMLSLD(Cond cond, ArmReg RdHi, ArmReg RdLo, ArmReg Rm, bool M, ArmReg Rn) override; + void SMUAD(Cond cond, ArmReg Rd, ArmReg Rm, bool M, ArmReg Rn) override; + void SMUSD(Cond cond, ArmReg Rd, ArmReg Rm, bool M, ArmReg Rn) override; + + // Parallel Add/Subtract (Modulo arithmetic) instructions + void SADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void USAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void USUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void USUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + + // Parallel Add/Subtract (Saturating) instructions + void QADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UQADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UQADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UQASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UQSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UQSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UQSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + + // Parallel Add/Subtract (Halving) instructions + void SHADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SHADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SHASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SHSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SHSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SHSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UHADD8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UHADD16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UHASX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UHSAX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UHSUB8(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void UHSUB16(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + + // Saturated Add/Subtract instructions + void QADD(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QSUB(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QDADD(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void QDSUB(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + + // Synchronization Primitive instructions + void CLREX() override; + void LDREX(Cond cond, ArmReg Rn, ArmReg Rd) override; + void LDREXB(Cond cond, ArmReg Rn, ArmReg Rd) override; + void LDREXD(Cond cond, ArmReg Rn, ArmReg Rd) override; + void LDREXH(Cond cond, ArmReg Rn, ArmReg Rd) override; + void STREX(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void STREXB(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void STREXD(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void STREXH(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SWP(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + void SWPB(Cond cond, ArmReg Rn, ArmReg Rd, ArmReg Rm) override; + + // Status register access instructions + void CPS() override; + void MRS() override; + void MSR() override; + void RFE() override; + void SETEND(bool E) override; + void SRS() override; + + // Thumb specific instructions + void thumb_B(Cond cond, ArmImm8 imm8) override; + void thumb_B(ArmImm11 imm11) override; + void thumb_BLX_prefix(ArmImm11 imm11) override; + void thumb_BLX_suffix(bool L, ArmImm11 imm11) override; + + ArmImm11 thumb_BLX_prefix_imm11 = 0; + bool thumb_BLX_prefix_executed = false; + bool thumb_BLX_suffix_executed = false; +}; + +} // namespace JitX64 diff --git a/src/core/arm/jit_x64/reg_alloc.cpp b/src/core/arm/jit_x64/reg_alloc.cpp new file mode 100644 index 000000000..e2dda7a9a --- /dev/null +++ b/src/core/arm/jit_x64/reg_alloc.cpp @@ -0,0 +1,383 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include + +#include "common/assert.h" +#include "common/x64/abi.h" + +#include "core/arm/jit_x64/reg_alloc.h" + +namespace JitX64 { + +const std::map RegAlloc::x64_reg_to_index = { + // Ordered such that the caller saved registers are on top, + // and registers often flushed at the bottom. + { Gen::R10, 0 }, + { Gen::R11, 1 }, + { Gen::RBX, 2 }, + { Gen::RBP, 3 }, + { Gen::R12, 4 }, + { Gen::R13, 5 }, + { Gen::R14, 6 }, + { Gen::RAX, 7 }, + { Gen::R9, 8 }, + { Gen::R8, 9 }, + { Gen::RSI, 10 }, + { Gen::RDX, 11 }, + { Gen::RDI, 12 }, + { Gen::RCX, 13 }, + { Gen::RSP, 14 }, +}; + +constexpr Gen::X64Reg jit_state_reg = Gen::R15; + +Gen::X64Reg RegAlloc::JitStateReg() const { + return jit_state_reg; +} + +static Gen::OpArg MJitStateCpuReg(ArmReg arm_reg) { + // The below pointer arithmetic assumes the following: + static_assert(std::is_same::value, "JitState::cpu_state must be ARMul_State"); + static_assert(std::is_same>::value, "ARMul_State::Reg must be std::array"); + + ASSERT(IsValidArmReg(arm_reg)); + + return Gen::MDisp(jit_state_reg, offsetof(JitState, cpu_state) + offsetof(ARMul_State, Reg) + static_cast(arm_reg) * sizeof(u32)); +} + +void RegAlloc::Init(Gen::XEmitter* emitter) { + code = emitter; + + for (size_t i = 0; i < arm_gpr.size(); i++) { + const ArmReg arm_reg = static_cast(i); + arm_gpr[i] = { arm_reg, MJitStateCpuReg(arm_reg), false }; + } + + for (const auto& entry : x64_reg_to_index) { + const Gen::X64Reg x64_reg = entry.first; + const size_t i = entry.second; + x64_gpr[i] = { x64_reg, false, X64State::State::Free, ArmReg::INVALID_REG }; + } +} + +void RegAlloc::FlushX64(Gen::X64Reg x64_reg) { + X64State& x64_state = GetState(x64_reg); + + ASSERT(!x64_state.locked); + + switch (x64_state.state) { + case X64State::State::Free: + case X64State::State::Temp: + x64_state.state = X64State::State::Free; + break; + case X64State::State::CleanArmReg: { + ArmState& arm_state = GetState(x64_state.arm_reg); + AssertStatesConsistent(x64_state, arm_state); + + // We ignore the value in the x64 register since it's not dirty. + x64_state.state = X64State::State::Free; + arm_state.location = MJitStateCpuReg(x64_state.arm_reg); + break; + } + case X64State::State::DirtyArmReg: { + AssertStatesConsistent(x64_state, GetState(x64_state.arm_reg)); + + // Flush the value in the x64 register back into ARMul_State since it's dirty. + FlushArm(x64_state.arm_reg); + break; + } + default: + UNREACHABLE(); + break; + } + + ASSERT(x64_state.state == X64State::State::Free); + ASSERT(!x64_state.locked); +} + +void RegAlloc::LockX64(Gen::X64Reg x64_reg) { + X64State& x64_state = GetState(x64_reg); + + ASSERT(!x64_state.locked && x64_state.state == X64State::State::Free); + + x64_state.locked = true; + x64_state.state = X64State::State::UserManuallyLocked; +} + +void RegAlloc::UnlockX64(Gen::X64Reg x64_reg) { + X64State& x64_state = GetState(x64_reg); + + ASSERT(x64_state.locked && x64_state.state == X64State::State::UserManuallyLocked); + + x64_state.locked = false; + x64_state.state = X64State::State::Free; +} + +void RegAlloc::FlushArm(ArmReg arm_reg) { + ArmState& arm_state = GetState(arm_reg); + + ASSERT(!arm_state.locked); + + if (!arm_state.IsInX64Register()) + return; // Nothing to do + + X64State& x64_state = GetState(GetX64For(arm_reg)); + + ASSERT(!x64_state.locked); + + if (x64_state.state == X64State::State::DirtyArmReg) { + code->MOV(32, MJitStateCpuReg(arm_reg), R(x64_state.x64_reg)); + } + + x64_state.state = X64State::State::Free; + arm_state.location = MJitStateCpuReg(arm_reg); +} + +Gen::OpArg RegAlloc::LockArmForRead(ArmReg arm_reg) { + ASSERT(arm_reg != ArmReg::PC); // Not valid for R15 (cannot read from it) + + ArmState& arm_state = GetState(arm_reg); + + if (arm_state.IsInX64Register()) { + X64State& x64_state = GetState(GetX64For(arm_reg)); + ASSERT(!x64_state.locked); + x64_state.locked = true; + } + + ASSERT(!arm_state.locked); + arm_state.locked = true; + + return arm_state.location; +} + +Gen::OpArg RegAlloc::LockArmForWrite(ArmReg arm_reg) { + // Valid for R15 (write-only) + + ArmState& arm_state = GetState(arm_reg); + + if (arm_state.IsInX64Register()) { + X64State& x64_state = GetState(GetX64For(arm_reg)); + ASSERT(!x64_state.locked); + x64_state.locked = true; + x64_state.state = X64State::State::DirtyArmReg; + } + + ASSERT(!arm_state.locked); + arm_state.locked = true; + + return arm_state.location; +} + +Gen::X64Reg RegAlloc::BindArmToX64(ArmReg arm_reg, bool load) { + ArmState& arm_state = GetState(arm_reg); + + ASSERT(!arm_state.locked); + + if (arm_state.IsInX64Register()) { + X64State& x64_state = GetState(GetX64For(arm_reg)); + ASSERT(!x64_state.locked); + arm_state.locked = true; + x64_state.locked = true; + return x64_state.x64_reg; + } + + const Gen::X64Reg x64_reg = AllocReg(); + X64State& x64_state = GetState(x64_reg); + + ASSERT(!x64_state.locked && x64_state.state == X64State::State::Free); + + x64_state.locked = true; + x64_state.arm_reg = arm_reg; + x64_state.state = X64State::State::CleanArmReg; + + if (load) + code->MOV(32, R(x64_reg), MJitStateCpuReg(arm_reg)); + + arm_state.locked = true; + arm_state.location = R(x64_reg); + + return x64_reg; +} + +Gen::X64Reg RegAlloc::BindArmForRead(ArmReg arm_reg) { + ASSERT(arm_reg != ArmReg::PC); // Not valid for R15 (cannot read from it) + + return BindArmToX64(arm_reg, true); +} + +Gen::X64Reg RegAlloc::BindArmForWrite(ArmReg arm_reg) { + // Valid for R15 (we're not reading from it) + + const Gen::X64Reg x64_reg = BindArmToX64(arm_reg, false); + + MarkDirty(arm_reg); + + return x64_reg; +} + +void RegAlloc::UnlockArm(ArmReg arm_reg) { + ArmState& arm_state = GetState(arm_reg); + + if (arm_state.IsInX64Register()) { + X64State& x64_state = GetState(GetX64For(arm_reg)); + ASSERT(x64_state.locked); + x64_state.locked = false; + } + + ASSERT(arm_state.locked); + arm_state.locked = false; +} + +void RegAlloc::MarkDirty(ArmReg arm_reg) { + const ArmState& arm_state = GetState(arm_reg); + + ASSERT(arm_state.locked && arm_state.IsInX64Register()); + + X64State& x64_state = GetState(GetX64For(arm_reg)); + + ASSERT(x64_state.locked); + + x64_state.state = X64State::State::DirtyArmReg; +} + +void RegAlloc::FlushEverything() { + for (const X64State& x64_state : x64_gpr) { + ASSERT(!x64_state.locked); + FlushX64(x64_state.x64_reg); + ASSERT(x64_state.state == X64State::State::Free); + } +} + +void RegAlloc::FlushABICallerSaved() { + for (const X64State& x64_state : x64_gpr) { + if (!ABI_ALL_CALLER_SAVED[x64_state.x64_reg]) + continue; + if (x64_state.state != X64State::State::UserManuallyLocked) { + ASSERT(!x64_state.locked); + FlushX64(x64_state.x64_reg); + ASSERT(x64_state.state == X64State::State::Free); + } else { + ASSERT(x64_state.locked); + } + } + + ASSERT(!ABI_ALL_CALLER_SAVED[JitStateReg()]); +} + +RegAlloc::X64State& RegAlloc::GetState(Gen::X64Reg x64_reg) { + ASSERT(x64_reg_to_index.find(x64_reg) != x64_reg_to_index.end()); + const size_t x64_index = x64_reg_to_index.at(x64_reg); + ASSERT(x64_gpr[x64_index].x64_reg == x64_reg); + return x64_gpr[x64_index]; +} + +const RegAlloc::X64State& RegAlloc::GetState(Gen::X64Reg x64_reg) const { + ASSERT(x64_reg_to_index.find(x64_reg) != x64_reg_to_index.end()); + const size_t x64_index = x64_reg_to_index.at(x64_reg); + ASSERT(x64_gpr[x64_index].x64_reg == x64_reg); + return x64_gpr[x64_index]; +} + +RegAlloc::ArmState& RegAlloc::GetState(ArmReg arm_reg) { + ASSERT(IsValidArmReg(arm_reg)); + const size_t arm_index = static_cast(arm_reg); + ASSERT(arm_gpr[arm_index].arm_reg == arm_reg); + return arm_gpr[arm_index]; +} + +const RegAlloc::ArmState& RegAlloc::GetState(ArmReg arm_reg) const { + ASSERT(IsValidArmReg(arm_reg)); + const size_t arm_index = static_cast(arm_reg); + ASSERT(arm_gpr[arm_index].arm_reg == arm_reg); + return arm_gpr[arm_index]; +} + +void RegAlloc::AssertStatesConsistent(const X64State& x64_state, const ArmState& arm_state) const { + ASSERT(arm_state.locked == x64_state.locked); + + ASSERT(arm_state.IsInX64Register()); + ASSERT(arm_state.location.GetSimpleReg() == x64_state.x64_reg); + + ASSERT(x64_state.arm_reg == arm_state.arm_reg); + ASSERT(x64_state.state == X64State::State::CleanArmReg || x64_state.state == X64State::State::DirtyArmReg); +} + +Gen::X64Reg RegAlloc::GetX64For(ArmReg arm_reg) const { + const ArmState& arm_state = GetState(arm_reg); + + ASSERT(arm_state.IsInX64Register()); + + const Gen::X64Reg x64_reg = arm_state.location.GetSimpleReg(); + + AssertStatesConsistent(GetState(x64_reg), arm_state); + + return x64_reg; +} + +Gen::X64Reg RegAlloc::AllocTemp() { + const Gen::X64Reg x64_reg = AllocReg(); + X64State& x64_state = GetState(x64_reg); + + ASSERT(!x64_state.locked && x64_state.state == X64State::State::Free); + + x64_state.locked = true; + x64_state.state = X64State::State::Temp; + + return x64_reg; +} + +void RegAlloc::UnlockTemp(Gen::X64Reg x64_reg) { + X64State& x64_state = GetState(x64_reg); + + ASSERT(x64_state.locked); + ASSERT(x64_state.state == X64State::State::Temp); + + x64_state.locked = false; + x64_state.state = X64State::State::Free; +} + +void RegAlloc::AssertNoLocked() const { + ASSERT(std::all_of(arm_gpr.begin(), arm_gpr.end(), [&](const ArmState& arm_state) { + if (arm_state.IsInX64Register()) { + const X64State& x64_state = GetState(GetX64For(arm_state.arm_reg)); + AssertStatesConsistent(x64_state, arm_state); + } + return !arm_state.locked; + })); + + ASSERT(std::all_of(x64_gpr.begin(), x64_gpr.end(), [](const X64State& x64_state) { + ASSERT(x64_state.state != X64State::State::Temp); // Temp is never unlocked. + return !x64_state.locked; + })); +} + +Gen::X64Reg RegAlloc::AllocReg() { + // TODO: Improve with an actual register allocator as this is terrible. + + // First check to see if there anything free. + auto free_x64 = std::find_if(x64_gpr.begin(), x64_gpr.end(), [](const auto& x64_state) { + return !x64_state.locked && x64_state.state == X64State::State::Free; + }); + + if (free_x64 != x64_gpr.end()) { + return free_x64->x64_reg; + } + + // Otherwise flush something. + auto flushable_x64 = std::find_if(x64_gpr.begin(), x64_gpr.end(), [](const auto& x64_state) { + return !x64_state.locked; + }); + + if (flushable_x64 != x64_gpr.end()) { + FlushX64(flushable_x64->x64_reg); + return flushable_x64->x64_reg; + } + + ASSERT_MSG(false, "Ran out of x64 registers"); + UNREACHABLE(); +} + +} diff --git a/src/core/arm/jit_x64/reg_alloc.h b/src/core/arm/jit_x64/reg_alloc.h new file mode 100644 index 000000000..c755f1220 --- /dev/null +++ b/src/core/arm/jit_x64/reg_alloc.h @@ -0,0 +1,210 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +#include "common/x64/emitter.h" + +#include "core/arm/decoder/decoder.h" +#include "core/arm/jit_x64/common.h" + +namespace JitX64 { + +// This is the register allocator +// TODO: Better algorithm required, ideally something that does reigster usage lookahead. +// (Designed so it should be simple to implement later.) + +class RegAlloc final { +public: + RegAlloc() { Init(nullptr); } + + /// Initialise register allocator (call before compiling a basic block as it resets internal state) + void Init(Gen::XEmitter* emitter); + + // Manually load and unlock x64 registers: + // This is required rarely. The most significant case is when shifting, + // because shift instructions must use the CL register. + + /// Ensures that the state of that register is State::Free. + void FlushX64(Gen::X64Reg x64_reg); + /// Locks a register: Marks it as in-use so it isn't allocated. + void LockX64(Gen::X64Reg x64_reg); + /// Unlocks a register: Allows it to be used for allocation again. + void UnlockX64(Gen::X64Reg x64_reg); + + // Working with ARM registers: + + /** + * Locks an ARM register so it doesn't move; ARM reg may either be in a x64 reg or in memory. + * We're going to read from it only. + * Call UnlockArm when done. + */ + Gen::OpArg LockArmForRead(ArmReg arm_reg); + /** + * Locks an ARM register so it doesn't move; ARM reg may either be in a x64 reg or in memory. + * We're going to read and/or write to it. + * Call UnlockArm when done. + */ + Gen::OpArg LockArmForReadWrite(ArmReg arm_reg) { + Gen::OpArg ret = LockArmForRead(arm_reg); + if (GetState(arm_reg).IsInX64Register()) { + MarkDirty(arm_reg); + } + return ret; + } + /** + * Locks an ARM register so it doesn't move; ARM reg may either be in a x64 reg or in memory. + * We're going to write to it only. + * Call UnlockArm when done. + */ + Gen::OpArg LockArmForWrite(ArmReg arm_reg); + + /** + * Binds an ARM register to a x64 register. + * We're going to read from it only. + * Call UnlockArm when done. + */ + Gen::X64Reg BindArmForRead(ArmReg arm_reg); + /** + * Binds an ARM register to a x64 register. + * We're going to read and/or write to it. + * Call UnlockArm when done. + */ + Gen::X64Reg BindArmForReadWrite(ArmReg arm_reg) { + Gen::X64Reg ret = BindArmForRead(arm_reg); + MarkDirty(arm_reg); + return ret; + } + /** + * Binds an ARM register to a x64 register. + * We're going to write to it only. + * Call UnlockArm when done. + */ + Gen::X64Reg BindArmForWrite(ArmReg arm_reg); + + /// Unlock ARM register. + void UnlockArm(ArmReg arm_reg); + + // Temporaries: + + /// Allocates a temporary register + Gen::X64Reg AllocTemp(); + /// Releases a temporary register + void UnlockTemp(Gen::X64Reg x64_reg); + + // JitState pointer: + + /// Returns the register in which the JitState pointer is stored. + Gen::X64Reg JitStateReg() const; + + // Flush: + + /** + * Flush absolutely everything. + * You MUST always flush everything: + * - just before a branch occurs + * - just before calling into the interpreter + * - just before calling a host function + * - just before returning to the dispatcher + * - just before jumping to a new BB + * If unsure, flush. (Only cost is performance.) + */ + void FlushEverything(); + + /** + * Flush only those registers that are caller-saved in the ABI. + * All registers must be unlocked except those locked by LockX64. + * (We assume you know what you're doing if you've manually locked registers.) + */ + void FlushABICallerSaved(); + + /// Ensures that the ARM register arm_reg is not in an x64 register. + void FlushArm(ArmReg arm_reg); + + // Debug: + + void AssertNoLocked() const; + +private: + struct ArmState { + ArmState() = default; + ArmState(ArmReg arm_reg, Gen::OpArg location, bool locked) : arm_reg(arm_reg), location(location), locked(locked) {} + + /// Which register is this? + ArmReg arm_reg = ArmReg::INVALID_REG; + + /** + * Where is the current value of this register? There are two cases: + * - In an x64 register, in which case location.IsSimpleReg() == true. + * - In memory in ARMul_State, in which case location == MJitStateCpuReg(arm_reg). + */ + Gen::OpArg location = { 0, 0, Gen::INVALID_REG, Gen::INVALID_REG }; + + /// Are we currently in-use? + bool locked = false; + + bool IsInX64Register() const { return location.IsSimpleReg(); } + }; + + /** + * Possible states of X64State: + * + * Free (locked must be false): This x64 reg is free to be allocated for any purpose. + * Temp (locked must be true): This x64 reg is being used as a temporary in a calculation. + * DirtyArmReg (arm_reg is valid): This x64 reg is bound to an ARM reg. + * It is marked as dirty (value has changed). + * This value MUST be flushed back to memory. + * CleanArmReg (arm_reg is valid): This x64 reg is bound to an ARM reg. + * It hasn't been written to (i.e.: value is still the same as the in-memory version). + * This value WILL NOT be flushed back to memory. + * UserManuallyLocked: User has called LockX64 on this register. User must call UnlockX64 to unlock. + */ + struct X64State { + enum class State { + Free, + Temp, + DirtyArmReg, + CleanArmReg, + UserManuallyLocked + }; + + X64State() = default; + X64State(Gen::X64Reg x64_reg, bool locked, State state, ArmReg arm_reg) : x64_reg(x64_reg), locked(locked), state(state), arm_reg(arm_reg) {} + + Gen::X64Reg x64_reg = Gen::INVALID_REG; + bool locked = false; + State state = State::Free; + ArmReg arm_reg = ArmReg::INVALID_REG; ///< Only holds a valid value when state == DirtyArmReg / CleanArmReg + }; + + std::array arm_gpr; + std::array x64_gpr; + + Gen::XEmitter* code = nullptr; + +private: + static const std::map x64_reg_to_index; + + /// INTERNAL: Gets the X64State that corresponds to x64_reg. + X64State& GetState(Gen::X64Reg x64_reg); + const X64State& GetState(Gen::X64Reg x64_reg) const; + /// INTERNAL: Gets the ArmState that corresponds to arm_reg. + ArmState& GetState(ArmReg x64_reg); + const ArmState& GetState(ArmReg x64_reg) const; + /// INTERNAL: Checks consistency of the two states + void AssertStatesConsistent(const X64State& x64_state, const ArmState& arm_state) const; + /// INTERNAL: Gets the x64 register this ArmReg is currently bound to. + Gen::X64Reg GetX64For(ArmReg arm_reg) const; + /// INTERNAL: Marks register as dirty. Ensures that it is written back to memory if it's in a x64 register. + void MarkDirty(ArmReg arm_reg); + /// INTERNAL: Allocates a register that is free. Flushes registers that are not locked if necessary. + Gen::X64Reg AllocReg(); + /// INTERNAL: Binds an ARM register to an X64 register. Retrieves binding if already bound. + Gen::X64Reg BindArmToX64(ArmReg arm_reg, bool load); +}; + +} diff --git a/src/core/arm/skyeye_common/armstate.h b/src/core/arm/skyeye_common/armstate.h index d42ff2669..39777055c 100644 --- a/src/core/arm/skyeye_common/armstate.h +++ b/src/core/arm/skyeye_common/armstate.h @@ -240,7 +240,6 @@ public: // process for our purposes), not per ARMul_State (which tracks CPU core state). std::unordered_map instruction_cache; -private: void ResetMPCoreCP15Registers(); // Defines a reservation granule of 2 words, which protects the first 2 words starting at the tag. diff --git a/src/core/memory.cpp b/src/core/memory.cpp index 7de5bd15d..94d65e482 100644 --- a/src/core/memory.cpp +++ b/src/core/memory.cpp @@ -104,6 +104,13 @@ void UnmapRegion(VAddr base, u32 size) { ASSERT_MSG((size & PAGE_MASK) == 0, "non-page aligned size: %08X", size); ASSERT_MSG((base & PAGE_MASK) == 0, "non-page aligned base: %08X", base); MapPages(base / PAGE_SIZE, size / PAGE_SIZE, nullptr, PageType::Unmapped); + + auto region_iter = std::find_if(current_page_table->special_regions.begin(), current_page_table->special_regions.end(), + [base, size] (const auto& region) { return base == region.base && size == region.size; }); + + if (region_iter != current_page_table->special_regions.end()) { + current_page_table->special_regions.erase(region_iter); + } } /** @@ -111,7 +118,7 @@ void UnmapRegion(VAddr base, u32 size) { */ static MMIORegionPointer GetMMIOHandler(VAddr vaddr) { for (const auto& region : current_page_table->special_regions) { - if (vaddr >= region.base && vaddr < (region.base + region.size)) { + if (vaddr >= region.base && (vaddr - region.base) < region.size) { return region.handler; } } diff --git a/src/core/memory_setup.h b/src/core/memory_setup.h index 05f70a1fe..77571ae2a 100644 --- a/src/core/memory_setup.h +++ b/src/core/memory_setup.h @@ -7,6 +7,7 @@ #include "common/common_types.h" #include "core/memory.h" +#include "core/mmio.h" namespace Memory { diff --git a/src/tests/CMakeLists.txt b/src/tests/CMakeLists.txt new file mode 100644 index 000000000..034dcdfea --- /dev/null +++ b/src/tests/CMakeLists.txt @@ -0,0 +1,47 @@ +set(SRCS + tests.cpp + ) + +set(HEADERS + ) + +if(ARCHITECTURE_x86_64) + set(SRCS ${SRCS} + core/arm/jit_x64/fuzz_arm_branch.cpp + core/arm/jit_x64/fuzz_arm_common.cpp + core/arm/jit_x64/fuzz_arm_data_processing.cpp + core/arm/jit_x64/fuzz_arm_load_store.cpp + core/arm/jit_x64/fuzz_thumb.cpp + ) + + set(HEADERS ${HEADERS} + core/arm/jit_x64/fuzz_arm_common.h + core/arm/jit_x64/rand_int.h + ) +endif() + +create_directory_groups(${SRCS} ${HEADERS}) + +include_directories(../../externals/catch) + +add_executable(tests ${SRCS} ${HEADERS}) +target_link_libraries(tests core video_core audio_core common) +target_link_libraries(tests ${SDL2_LIBRARY} ${OPENGL_gl_LIBRARY} inih glad) +if (MSVC) + target_link_libraries(tests getopt) +endif() +target_link_libraries(tests ${PLATFORM_LIBRARIES}) + +if(${CMAKE_SYSTEM_NAME} MATCHES "Linux|FreeBSD|OpenBSD|NetBSD") + install(TARGETS tests RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}/bin") +endif() + +if (MSVC) + include(WindowsCopyFiles) + + set(DLL_DEST "${CMAKE_BINARY_DIR}/bin/$/") + + windows_copy_files(tests ${SDL2_DLL_DIR} ${DLL_DEST} SDL2.dll) + + unset(DLL_DEST) +endif() diff --git a/src/tests/core/arm/jit_x64/fuzz_arm_branch.cpp b/src/tests/core/arm/jit_x64/fuzz_arm_branch.cpp new file mode 100644 index 000000000..502b4b310 --- /dev/null +++ b/src/tests/core/arm/jit_x64/fuzz_arm_branch.cpp @@ -0,0 +1,39 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include + +#include + +#include "common/common_types.h" + +#include "tests/core/arm/jit_x64/rand_int.h" +#include "tests/core/arm/jit_x64/fuzz_arm_common.h" + +TEST_CASE("Fuzz ARM branch instructions", "[JitX64]") { + const std::array, 6> instructions = {{ + FromBitString32("1111101hvvvvvvvvvvvvvvvvvvvvvvvv"), + FromBitString32("cccc000100101111111111110011mmmm"), + FromBitString32("cccc1010vvvvvvvvvvvvvvvvvvvvvvvv"), + FromBitString32("cccc1011vvvvvvvvvvvvvvvvvvvvvvvv"), + FromBitString32("cccc000100101111111111110001mmmm"), + FromBitString32("cccc000100101111111111110010mmmm"), + }}; + + auto instruction_select = [&]() -> u32 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + u32 cond = RandInt(0, 0xE); + u32 random = RandInt(0, 0xFFFFFF); + u32 Rm = RandInt(0, 14); + + u32 assemble_randoms = (cond << 28) | (random << 4) | Rm; + + return instructions[inst_index].first | (assemble_randoms & (~instructions[inst_index].second)); + }; + + SECTION("R15") { + FuzzJit(1, 1, 10000, instruction_select); + } +} \ No newline at end of file diff --git a/src/tests/core/arm/jit_x64/fuzz_arm_common.cpp b/src/tests/core/arm/jit_x64/fuzz_arm_common.cpp new file mode 100644 index 000000000..5f5138d83 --- /dev/null +++ b/src/tests/core/arm/jit_x64/fuzz_arm_common.cpp @@ -0,0 +1,206 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include +#include +#include + +#include + +#include "common/common_types.h" +#include "common/scope_exit.h" + +#include "core/arm/disassembler/arm_disasm.h" +#include "core/arm/dyncom/arm_dyncom.h" +#include "core/arm/jit_x64/interface.h" +#include "core/core.h" +#include "core/memory_setup.h" +#include "core/mmio.h" + +#include "tests/core/arm/jit_x64/fuzz_arm_common.h" +#include "tests/core/arm/jit_x64/rand_int.h" + +std::pair FromBitString32(const char* str) { + REQUIRE(strlen(str) == 32); + + u32 bits = 0; + u32 mask = 0; + for (int i = 0; i < 32; i++) { + const u32 bit = 1 << (31 - i); + switch (str[i]) { + case '0': + mask |= bit; + break; + case '1': + bits |= bit; + mask |= bit; + break; + default: + // Do nothing + break; + } + } + return{ bits, mask }; +} + +class TestMemory final : public Memory::MMIORegion { +public: + static constexpr size_t CODE_MEMORY_SIZE = 4096 * 2; + std::array code_mem{}; + + u8 Read8(VAddr addr) override { return addr; } + u16 Read16(VAddr addr) override { return addr; } + u32 Read32(VAddr addr) override { + if (addr < CODE_MEMORY_SIZE) { + return code_mem[addr/4]; + } else { + return addr; + } + } + u64 Read64(VAddr addr) override { return addr; } + + struct WriteRecord { + WriteRecord(size_t size, VAddr addr, u64 data) : size(size), addr(addr), data(data) {} + size_t size; + VAddr addr; + u64 data; + bool operator==(const WriteRecord& o) const { + return std::tie(size, addr, data) == std::tie(o.size, o.addr, o.data); + } + }; + + std::vector recording; + + void Write8(VAddr addr, u8 data) override { recording.emplace_back(1, addr, data); } + void Write16(VAddr addr, u16 data) override { recording.emplace_back(2, addr, data); } + void Write32(VAddr addr, u32 data) override { recording.emplace_back(4, addr, data); } + void Write64(VAddr addr, u64 data) override { recording.emplace_back(8, addr, data); } +}; + +static bool DoesBehaviorMatch(const ARM_DynCom& interp, const JitX64::ARM_Jit& jit, std::vector interp_mem_recording, std::vector jit_mem_recording) { + if (interp.GetCPSR() != jit.GetCPSR()) + return false; + + for (int i = 0; i <= 15; i++) { + if (interp.GetReg(i) != jit.GetReg(i)) + return false; + } + + if (interp_mem_recording != jit_mem_recording) + return false; + + return true; +} + +void FuzzJit(const int instruction_count, const int instructions_to_execute_count, const int run_count, const std::function instruction_generator) { + // Init core + Core::Init(); + SCOPE_EXIT({ Core::Shutdown(); }); + + // Prepare memory (we take over the entire address space) + std::shared_ptr test_mem = std::make_shared(); + Memory::MapIoRegion(0x00000000, 0x80000000, test_mem); + Memory::MapIoRegion(0x80000000, 0x80000000, test_mem); + SCOPE_EXIT({ + Memory::UnmapRegion(0x00000000, 0x80000000); + Memory::UnmapRegion(0x80000000, 0x80000000); + }); + + // Prepare test subjects + JitX64::ARM_Jit jit(PrivilegeMode::USER32MODE); + ARM_DynCom interp(PrivilegeMode::USER32MODE); + SCOPE_EXIT({ + jit.FastClearCache(); + interp.ClearCache(); + }); + + for (int run_number = 0; run_number < run_count; run_number++) { + jit.FastClearCache(); + interp.ClearCache(); + + u32 initial_regs[15]; + for (int i = 0; i < 15; i++) { + u32 val = RandInt(0, 0xFFFFFFFF); + interp.SetReg(i, val); + jit.SetReg(i, val); + initial_regs[i] = val; + } + + interp.SetCPSR(0x000001d0); + jit.SetCPSR(0x000001d0); + + interp.SetPC(0); + jit.SetPC(0); + + std::generate_n(test_mem->code_mem.begin(), instruction_count, instruction_generator); + + test_mem->code_mem[instruction_count] = 0xEAFFFFFE; // b +#0 // busy wait loop + + test_mem->recording.clear(); + interp.ExecuteInstructions(instructions_to_execute_count); + auto interp_mem_recording = test_mem->recording; + + test_mem->recording.clear(); + jit.ExecuteInstructions(instructions_to_execute_count); + auto jit_mem_recording = test_mem->recording; + + if (!DoesBehaviorMatch(interp, jit, interp_mem_recording, jit_mem_recording)) { + printf("Failed at execution number %i\n", run_number); + + printf("\nInstruction Listing: \n"); + for (int i = 0; i < instruction_count; i++) { + printf("%s\n", ARM_Disasm::Disassemble(i * 4, Memory::Read32(i * 4)).c_str()); + } + + printf("\nFinal Register Listing: \n"); + printf(" R interp jit\n"); + for (int i = 0; i <= 15; i++) { + printf("%4i: %08x %08x %s\n", i, interp.GetReg(i), jit.GetReg(i), interp.GetReg(i) != jit.GetReg(i) ? "*" : ""); + } + printf("CPSR: %08x %08x %s\n", interp.GetCPSR(), jit.GetCPSR(), interp.GetCPSR() != jit.GetCPSR() ? "*" : ""); + + if (interp_mem_recording != jit_mem_recording) { + printf("memory write recording mismatch *\n"); + size_t i = 0; + while (i < interp_mem_recording.size() || i < jit_mem_recording.size()) { + if (i < interp_mem_recording.size()) + printf("interp: %zu %08x %08" PRIx64 "\n", interp_mem_recording[i].size, interp_mem_recording[i].addr, interp_mem_recording[i].data); + if (i < jit_mem_recording.size()) + printf("jit : %zu %08x %08" PRIx64 "\n", jit_mem_recording[i].size, jit_mem_recording[i].addr, jit_mem_recording[i].data); + i++; + } + } + + printf("\nInterpreter walkthrough:\n"); + interp.ClearCache(); + interp.SetPC(0); + interp.SetCPSR(0x000001d0); + for (int i = 0; i < 15; i++) { + interp.SetReg(i, initial_regs[i]); + printf("%4i: %08x\n", i, interp.GetReg(i)); + } + test_mem->recording.clear(); + for (int inst = 0; inst < instruction_count; inst++) { + printf("%s\n", ARM_Disasm::Disassemble(inst * 4, Memory::Read32(inst * 4)).c_str()); + interp.Step(); + for (int i = 0; i <= 15; i++) { + printf("%4i: %08x\n", i, interp.GetReg(i)); + } + printf("CPSR: %08x\n", interp.GetCPSR()); + } + +#ifdef _MSC_VER + DebugBreak(); +#endif + FAIL(); + } + + printf("%i\r", run_number); + if (run_number % 50 == 0) { + fflush(stdout); + } + } +} diff --git a/src/tests/core/arm/jit_x64/fuzz_arm_common.h b/src/tests/core/arm/jit_x64/fuzz_arm_common.h new file mode 100644 index 000000000..05c03d556 --- /dev/null +++ b/src/tests/core/arm/jit_x64/fuzz_arm_common.h @@ -0,0 +1,22 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +#include "common/common_types.h" + +std::pair FromBitString32(const char* str); + +/** + * For run_count times: + * 1. Generates instruction_count instructions using instruction_generator + * 2. Requests JitX64 and interpreter to execute them for instructions_to_execute_count instructions + * 3. Verifies that the register state are equivalent + * + * Note: A b #+0 instruction is appended to the list of instructions. + */ +void FuzzJit(const int instruction_count, const int instructions_to_execute_count, const int run_count, const std::function instruction_generator); diff --git a/src/tests/core/arm/jit_x64/fuzz_arm_data_processing.cpp b/src/tests/core/arm/jit_x64/fuzz_arm_data_processing.cpp new file mode 100644 index 000000000..2e493ea73 --- /dev/null +++ b/src/tests/core/arm/jit_x64/fuzz_arm_data_processing.cpp @@ -0,0 +1,115 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include + +#include + +#include "common/common_types.h" + +#include "tests/core/arm/jit_x64/rand_int.h" +#include "tests/core/arm/jit_x64/fuzz_arm_common.h" + +TEST_CASE("Fuzz ARM data processing instructions", "[JitX64]") { + const std::array, 48> instructions = {{ + FromBitString32("cccc0010101Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000101Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000101Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0010100Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000100Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000100Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0010000Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000000Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000000Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0011110Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0001110Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0001110Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc00110111nnnn0000rrrrvvvvvvvv"), + FromBitString32("cccc00010111nnnn0000vvvvvrr0mmmm"), + FromBitString32("cccc00010111nnnn0000ssss0rr1mmmm"), + FromBitString32("cccc00110101nnnn0000rrrrvvvvvvvv"), + FromBitString32("cccc00010101nnnn0000vvvvvrr0mmmm"), + FromBitString32("cccc00010101nnnn0000ssss0rr1mmmm"), + FromBitString32("cccc0010001Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000001Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000001Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0011101S0000ddddrrrrvvvvvvvv"), + FromBitString32("cccc0001101S0000ddddvvvvvrr0mmmm"), + FromBitString32("cccc0001101S0000ddddssss0rr1mmmm"), + FromBitString32("cccc0011111S0000ddddrrrrvvvvvvvv"), + FromBitString32("cccc0001111S0000ddddvvvvvrr0mmmm"), + FromBitString32("cccc0001111S0000ddddssss0rr1mmmm"), + FromBitString32("cccc0011100Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0001100Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0001100Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0010011Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000011Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000011Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0010111Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000111Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000111Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0010110Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000110Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000110Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc0010010Snnnnddddrrrrvvvvvvvv"), + FromBitString32("cccc0000010Snnnnddddvvvvvrr0mmmm"), + FromBitString32("cccc0000010Snnnnddddssss0rr1mmmm"), + FromBitString32("cccc00110011nnnn0000rrrrvvvvvvvv"), + FromBitString32("cccc00010011nnnn0000vvvvvrr0mmmm"), + FromBitString32("cccc00010011nnnn0000ssss0rr1mmmm"), + FromBitString32("cccc00110001nnnn0000rrrrvvvvvvvv"), + FromBitString32("cccc00010001nnnn0000vvvvvrr0mmmm"), + FromBitString32("cccc00010001nnnn0000ssss0rr1mmmm"), + }}; + + auto instruction_select_without_R15 = [&]() -> u32 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + u32 cond = 0xE; + // Have a one-in-twenty-five chance of actually having a cond. + if (RandInt(1, 25) == 1) { + cond = RandInt(0x0, 0xD); + } + + u32 Rn = RandInt(0, 15); + u32 Rd = RandInt(0, 14); + u32 S = RandInt(0, 1); + u32 shifter_operand = RandInt(0, 0xFFF); + + u32 assemble_randoms = (shifter_operand << 0) | (Rd << 12) | (Rn << 16) | (S << 20) | (cond << 28); + + return instructions[inst_index].first | (assemble_randoms & (~instructions[inst_index].second)); + }; + + SECTION("short blocks") { + FuzzJit(5, 6, 5000, instruction_select_without_R15); + } + + SECTION("long blocks") { + FuzzJit(1024, 1025, 200, instruction_select_without_R15); + } + + auto instruction_select_only_R15 = [&]() -> u32 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + u32 cond = 0xE; + // Have a one-in-twenty-five chance of actually having a cond. + if (RandInt(1, 25) == 1) { + cond = RandInt(0x0, 0xD); + } + + u32 Rn = RandInt(0, 15); + u32 Rd = 15; + u32 S = 0; + u32 shifter_operand = RandInt(0, 0xFFF); + + u32 assemble_randoms = (shifter_operand << 0) | (Rd << 12) | (Rn << 16) | (S << 20) | (cond << 28); + + return instructions[inst_index].first | (assemble_randoms & (~instructions[inst_index].second)); + }; + + SECTION("R15") { + FuzzJit(1, 1, 10000, instruction_select_only_R15); + } +} \ No newline at end of file diff --git a/src/tests/core/arm/jit_x64/fuzz_arm_load_store.cpp b/src/tests/core/arm/jit_x64/fuzz_arm_load_store.cpp new file mode 100644 index 000000000..05d06e1d3 --- /dev/null +++ b/src/tests/core/arm/jit_x64/fuzz_arm_load_store.cpp @@ -0,0 +1,156 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include + +#include + +#include "common/common_types.h" + +#include "tests/core/arm/jit_x64/rand_int.h" +#include "tests/core/arm/jit_x64/fuzz_arm_common.h" + +TEST_CASE("Fuzz ARM load/store instructions (byte, half-word, word)", "[JitX64]") { + const std::array, 17> instructions = {{ + FromBitString32("cccc010pu0w1nnnnddddvvvvvvvvvvvv"), // LDR_imm + FromBitString32("cccc011pu0w1nnnnddddvvvvvrr0mmmm"), // LDR_reg + FromBitString32("cccc010pu1w1nnnnddddvvvvvvvvvvvv"), // LDRB_imm + FromBitString32("cccc011pu1w1nnnnddddvvvvvrr0mmmm"), // LDRB_reg + FromBitString32("cccc010pu0w0nnnnddddvvvvvvvvvvvv"), // STR_imm + FromBitString32("cccc011pu0w0nnnnddddvvvvvrr0mmmm"), // STR_reg + FromBitString32("cccc010pu1w0nnnnddddvvvvvvvvvvvv"), // STRB_imm + FromBitString32("cccc011pu1w0nnnnddddvvvvvrr0mmmm"), // STRB_reg + FromBitString32("cccc000pu1w1nnnnddddvvvv1011vvvv"), // LDRH_imm + FromBitString32("cccc000pu0w1nnnndddd00001011mmmm"), // LDRH_reg + FromBitString32("cccc000pu1w1nnnnddddvvvv1101vvvv"), // LDRSB_imm + FromBitString32("cccc000pu0w1nnnndddd00001101mmmm"), // LDRSB_reg + FromBitString32("cccc000pu1w1nnnnddddvvvv1111vvvv"), // LDRSH_imm + FromBitString32("cccc000pu0w1nnnndddd00001111mmmm"), // LDRSH_reg + FromBitString32("cccc000pu1w0nnnnddddvvvv1011vvvv"), // STRH_imm + FromBitString32("cccc000pu0w0nnnndddd00001011mmmm"), // STRH_reg + FromBitString32("1111000100000001000000e000000000"), // SETEND + }}; + + auto instruction_select = [&]() -> u32 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + u32 cond = 0xE; + // Have a one-in-twenty-five chance of actually having a cond. + if (RandInt(1, 25) == 1) { + cond = RandInt(0x0, 0xD); + } + + u32 Rn = RandInt(0, 14); + u32 Rd = RandInt(0, 14); + u32 W = 0; + u32 P = RandInt(0, 1); + if (P) W = RandInt(0, 1); + u32 U = RandInt(0, 1); + u32 rand = RandInt(0, 0xFF); + u32 Rm = RandInt(0, 14); + + if (W) { + while (Rn == Rd) { + Rn = RandInt(0, 14); + Rd = RandInt(0, 14); + } + } + + u32 assemble_randoms = (Rm << 0) | (rand << 4) | (Rd << 12) | (Rn << 16) | (W << 21) | (U << 23) | (P << 24) | (cond << 28); + + return instructions[inst_index].first | (assemble_randoms & (~instructions[inst_index].second)); + }; + + SECTION("short blocks") { + FuzzJit(5, 6, 1000, instruction_select); + } +} + +TEST_CASE("Fuzz ARM load/store instructions (double-word)", "[JitX64]") { + const std::array, 4> instructions = {{ + FromBitString32("cccc000pu1w0nnnnddddvvvv1101vvvv"), // LDRD_imm + FromBitString32("cccc000pu0w0nnnndddd00001101mmmm"), // LDRD_reg + FromBitString32("cccc000pu1w0nnnnddddvvvv1111vvvv"), // STRD_imm + FromBitString32("cccc000pu0w0nnnndddd00001111mmmm"), // STRD_reg + }}; + + auto instruction_select = [&]() -> u32 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + u32 cond = 0xE; + // Have a one-in-twenty-five chance of actually having a cond. + if (RandInt(1, 25) == 1) { + cond = RandInt(0x0, 0xD); + } + + u32 Rn = RandInt(0, 6) * 2; + u32 Rd = RandInt(0, 6) * 2; + u32 W = 0; + u32 P = RandInt(0, 1); + if (P) W = RandInt(0, 1); + u32 U = RandInt(0, 1); + u32 rand = RandInt(0, 0xF); + u32 Rm = RandInt(0, 14); + + if (W) { + while (Rn == Rd) { + Rn = RandInt(0, 6) * 2; + Rd = RandInt(0, 6) * 2; + } + } + + while (Rm == Rd || Rm == Rd + 1) { + Rm = RandInt(0, 14); + } + + u32 assemble_randoms = (Rm << 0) | (rand << 4) | (Rd << 12) | (Rn << 16) | (W << 21) | (U << 23) | (P << 24) | (cond << 28); + + return instructions[inst_index].first | (assemble_randoms & (~instructions[inst_index].second)); + }; + + SECTION("short blocks") { + FuzzJit(1, 2, 5000, instruction_select); + } +} + +TEST_CASE("Fuzz ARM load/store multiple instructions", "[JitX64]") { + const std::array, 2> instructions = {{ + FromBitString32("cccc100pu0w1nnnnxxxxxxxxxxxxxxxx"), // LDM + FromBitString32("cccc100pu0w0nnnnxxxxxxxxxxxxxxxx"), // STM + }}; + + auto instruction_select = [&]() -> u32 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + u32 cond = 0xE; + // Have a one-in-twenty-five chance of actually having a cond. + if (RandInt(1, 25) == 1) { + cond = RandInt(0x0, 0xD); + } + + u32 reg_list = RandInt(1, 0xFFFF); + u32 Rn = RandInt(0, 14); + u32 flags = RandInt(0, 0xF); + + while (true) { + if (inst_index == 1 && (flags & 2)) { + if (reg_list & (1 << Rn)) + reg_list &= ~((1 << Rn) - 1); + } else if (inst_index == 0 && (flags & 2)) { + reg_list &= ~(1 << Rn); + } + + if (reg_list) + break; + + reg_list = RandInt(1, 0xFFFF); + } + + u32 assemble_randoms = (reg_list << 0) | (Rn << 16) | (flags << 24) | (cond << 28); + + return instructions[inst_index].first | (assemble_randoms & (~instructions[inst_index].second)); + }; + + FuzzJit(1, 1, 10000, instruction_select); +} \ No newline at end of file diff --git a/src/tests/core/arm/jit_x64/fuzz_thumb.cpp b/src/tests/core/arm/jit_x64/fuzz_thumb.cpp new file mode 100644 index 000000000..50d0f7873 --- /dev/null +++ b/src/tests/core/arm/jit_x64/fuzz_thumb.cpp @@ -0,0 +1,335 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#include +#include +#include + +#include + +#include "common/scope_exit.h" + +#include "core/arm/dyncom/arm_dyncom.h" +#include "core/arm/jit_x64/interface.h" +#include "core/core.h" +#include "core/memory_setup.h" + +#include "tests/core/arm/jit_x64/rand_int.h" + +std::pair FromBitString16(const char* str) { + REQUIRE(strlen(str) == 16); + + u16 bits = 0; + u16 mask = 0; + for (int i = 0; i < 16; i++) { + const u16 bit = 1 << (15 - i); + switch (str[i]) { + case '0': + mask |= bit; + break; + case '1': + bits |= bit; + mask |= bit; + break; + default: + // Do nothing + break; + } + } + return{ bits, mask }; +} + +class TestMemory final : public Memory::MMIORegion { +public: + static constexpr size_t CODE_MEMORY_SIZE = 4096 * 2; + std::array code_mem{}; + + u8 Read8(VAddr addr) override { return addr; } + u16 Read16(VAddr addr) override { + if (addr < CODE_MEMORY_SIZE) { + addr /= 2; + return code_mem[addr]; + } else { + return addr; + } + } + u32 Read32(VAddr addr) override { + if (addr < CODE_MEMORY_SIZE) { + addr /= 2; + return code_mem[addr] | (code_mem[addr+1] << 16); + } else { + return addr; + } + } + u64 Read64(VAddr addr) override { return addr; } + + struct WriteRecord { + WriteRecord(size_t size, VAddr addr, u64 data) : size(size), addr(addr), data(data) {} + size_t size; + VAddr addr; + u64 data; + bool operator==(const WriteRecord& o) const { + return std::tie(size, addr, data) == std::tie(o.size, o.addr, o.data); + } + }; + + std::vector recording; + + void Write8(VAddr addr, u8 data) override { recording.emplace_back(1, addr, data); } + void Write16(VAddr addr, u16 data) override { recording.emplace_back(2, addr, data); } + void Write32(VAddr addr, u32 data) override { recording.emplace_back(4, addr, data); } + void Write64(VAddr addr, u64 data) override { recording.emplace_back(8, addr, data); } +}; + +static bool DoesBehaviorMatch(const ARM_DynCom& interp, const JitX64::ARM_Jit& jit, std::vector interp_mem_recording, std::vector jit_mem_recording) { + if (interp.GetCPSR() != jit.GetCPSR()) + return false; + + for (int i = 0; i <= 15; i++) { + if (interp.GetReg(i) != jit.GetReg(i)) + return false; + } + + if (interp_mem_recording != jit_mem_recording) + return false; + + return true; +} + +void FuzzJitThumb(const int instruction_count, const int instructions_to_execute_count, const int run_count, const std::function instruction_generator) { + // Init core + Core::Init(); + SCOPE_EXIT({ Core::Shutdown(); }); + + // Prepare memory + std::shared_ptr test_mem = std::make_shared(); + Memory::MapIoRegion(0x00000000, 0x80000000, test_mem); + Memory::MapIoRegion(0x80000000, 0x80000000, test_mem); + SCOPE_EXIT({ + Memory::UnmapRegion(0x00000000, 0x80000000); + Memory::UnmapRegion(0x80000000, 0x80000000); + }); + + // Prepare test subjects + JitX64::ARM_Jit jit(PrivilegeMode::USER32MODE); + ARM_DynCom interp(PrivilegeMode::USER32MODE); + SCOPE_EXIT({ + jit.FastClearCache(); + interp.ClearCache(); + }); + + for (int run_number = 0; run_number < run_count; run_number++) { + jit.FastClearCache(); + interp.ClearCache(); + + u32 initial_regs[15]; + for (int i = 0; i < 15; i++) { + u32 val = RandInt(0, 0xFFFFFFFF); + interp.SetReg(i, val); + jit.SetReg(i, val); + initial_regs[i] = val; + } + + interp.SetCPSR(0x000001d0); + jit.SetCPSR(0x000001d0); + + interp.SetPC(0); + jit.SetPC(0); + + test_mem->code_mem[0] = 0xFFFF; + test_mem->code_mem[1] = 0xFAFF; // blx +#4 // Jump to the following code (switch to thumb) + + for (int i = 0; i < instruction_count; i++) { + u16 inst = instruction_generator(i); + test_mem->code_mem[2 + i] = inst; + } + + test_mem->code_mem[2 + instruction_count] = 0xE7FE; // b +#0 // busy wait loop + + test_mem->recording.clear(); + interp.ExecuteInstructions(instructions_to_execute_count + 1); + auto interp_mem_recording = test_mem->recording; + + test_mem->recording.clear(); + jit.ExecuteInstructions(instructions_to_execute_count + 1); + auto jit_mem_recording = test_mem->recording; + + if (!DoesBehaviorMatch(interp, jit, interp_mem_recording, jit_mem_recording)) { + printf("Failed at execution number %i\n", run_number); + + printf("\nInstruction Listing: \n"); + for (int i = 0; i < instruction_count; i++) { + printf("%04x\n", test_mem->code_mem[2 + i]); + } + + printf("\nFinal Register Listing: \n"); + for (int i = 0; i <= 15; i++) { + printf("%4i: %08x %08x %s\n", i, interp.GetReg(i), jit.GetReg(i), interp.GetReg(i) != jit.GetReg(i) ? "*" : ""); + } + printf("CPSR: %08x %08x %s\n", interp.GetCPSR(), jit.GetCPSR(), interp.GetCPSR() != jit.GetCPSR() ? "*" : ""); + + if (interp_mem_recording != jit_mem_recording) { + printf("memory write recording mismatch *\n"); + size_t i = 0; + while (i < interp_mem_recording.size() || i < jit_mem_recording.size()) { + if (i < interp_mem_recording.size()) + printf("interp: %zu %08x %08" PRIx64 "\n", interp_mem_recording[i].size, interp_mem_recording[i].addr, interp_mem_recording[i].data); + if (i < jit_mem_recording.size()) + printf("jit : %zu %08x %08" PRIx64 "\n", jit_mem_recording[i].size, jit_mem_recording[i].addr, jit_mem_recording[i].data); + i++; + } + } + + printf("\nInterpreter walkthrough:\n"); + interp.ClearCache(); + interp.SetPC(0); + interp.SetCPSR(0x000001d0); + for (int i = 0; i < 15; i++) { + interp.SetReg(i, initial_regs[i]); + printf("%4i: %08x\n", i, interp.GetReg(i)); + } + for (int inst = 0; inst < instruction_count; inst++) { + interp.Step(); + for (int i = 0; i <= 15; i++) { + printf("%4i: %08x\n", i, interp.GetReg(i)); + } + printf("CPSR: %08x\n", interp.GetCPSR()); + } + +#ifdef _MSC_VER + DebugBreak(); +#endif + FAIL(); + } + + printf("%i\r", run_number); + if (run_number % 50 == 0) { + fflush(stdout); + } + } +} + +// Things not yet tested: +// +// FromBitString16("10111110xxxxxxxx"), // BKPT +// FromBitString16("11011111xxxxxxxx"), // SWI +// FromBitString16("1011x101xxxxxxxx"), // PUSH/POP (R = 1) + +TEST_CASE("Fuzz Thumb instructions set 1", "[JitX64][Thumb]") { + const std::array, 24> instructions = {{ + FromBitString16("00000xxxxxxxxxxx"), // LSL , , # + FromBitString16("00001xxxxxxxxxxx"), // LSR , , # + FromBitString16("00010xxxxxxxxxxx"), // ASR , , # + FromBitString16("000110oxxxxxxxxx"), // ADD/SUB_reg + FromBitString16("000111oxxxxxxxxx"), // ADD/SUB_imm + FromBitString16("001ooxxxxxxxxxxx"), // ADD/SUB/CMP/MOV_imm + FromBitString16("010000ooooxxxxxx"), // Data Processing + FromBitString16("010001000hxxxxxx"), // ADD (high registers) + FromBitString16("010001010hxxxxxx"), // CMP (high registers) + FromBitString16("01000101h0xxxxxx"), // CMP (high registers) + FromBitString16("010001100hxxxxxx"), // MOV (high registers) + FromBitString16("10110000oxxxxxxx"), // Adjust stack pointer + FromBitString16("10110010ooxxxxxx"), // SXT/UXT + FromBitString16("1011101000xxxxxx"), // REV + FromBitString16("1011101001xxxxxx"), // REV16 + FromBitString16("1011101011xxxxxx"), // REVSH + FromBitString16("01001xxxxxxxxxxx"), // LDR Rd, [PC, #] + FromBitString16("0101oooxxxxxxxxx"), // LDR/STR Rd, [Rn, Rm] + FromBitString16("011xxxxxxxxxxxxx"), // LDR(B)/STR(B) Rd, [Rn, #] + FromBitString16("1000xxxxxxxxxxxx"), // LDRH/STRH Rd, [Rn, #offset] + FromBitString16("1001xxxxxxxxxxxx"), // LDR/STR Rd, [SP, #] + FromBitString16("1011x100xxxxxxxx"), // PUSH/POP (R = 0) + FromBitString16("1100xxxxxxxxxxxx"), // STMIA/LDMIA + FromBitString16("101101100101x000"), // SETEND + }}; + + auto instruction_select = [&](int) -> u16 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + if (inst_index == 22) { + u16 L = RandInt(0, 1); + u16 Rn = RandInt(0, 7); + u16 reg_list = RandInt(1, 0xFF); + if (!L && (reg_list & (1 << Rn))) { + reg_list &= ~((1 << Rn) - 1); + if (reg_list == 0) reg_list = 0x80; + } + u16 random = (L << 11) | (Rn << 8) | reg_list; + return instructions[inst_index].first | (random &~instructions[inst_index].second); + } else if (inst_index == 21) { + u16 L = RandInt(0, 1); + u16 reg_list = RandInt(1, 0xFF); + u16 random = (L << 11) | reg_list; + return instructions[inst_index].first | (random &~instructions[inst_index].second); + } else { + u16 random = RandInt(0, 0xFFFF); + return instructions[inst_index].first | (random &~instructions[inst_index].second); + } + }; + + SECTION("short blocks") { + FuzzJitThumb(5, 6, 10000, instruction_select); + } + + SECTION("long blocks") { + FuzzJitThumb(1024, 1025, 15, instruction_select); + } +} + +TEST_CASE("Fuzz Thumb instructions set 2 (affects PC)", "[JitX64][Thumb]") { + const std::array, 19> instructions = {{ + FromBitString16("01000111xxxxx000"), // BLX/BX + FromBitString16("1010oxxxxxxxxxxx"), // add to pc/sp + FromBitString16("11100xxxxxxxxxxx"), // B + FromBitString16("01000100h0xxxxxx"), // ADD (high registers) + FromBitString16("01000110h0xxxxxx"), // MOV (high registers) + FromBitString16("11010000xxxxxxxx"), // B + FromBitString16("11010001xxxxxxxx"), // B + FromBitString16("11010010xxxxxxxx"), // B + FromBitString16("11010011xxxxxxxx"), // B + FromBitString16("11010100xxxxxxxx"), // B + FromBitString16("11010101xxxxxxxx"), // B + FromBitString16("11010110xxxxxxxx"), // B + FromBitString16("11010111xxxxxxxx"), // B + FromBitString16("11011000xxxxxxxx"), // B + FromBitString16("11011001xxxxxxxx"), // B + FromBitString16("11011010xxxxxxxx"), // B + FromBitString16("11011011xxxxxxxx"), // B + FromBitString16("11011100xxxxxxxx"), // B + FromBitString16("10110110011x0xxx"), // CPS + }}; + + auto instruction_select = [&](int) -> u16 { + size_t inst_index = RandInt(0, instructions.size() - 1); + + if (inst_index == 0) { + u16 Rm = RandInt(0, 14) << 3; + return instructions[inst_index].first | (Rm &~instructions[inst_index].second); + } else { + u16 random = RandInt(0, 0xFFFF); + return instructions[inst_index].first | (random &~instructions[inst_index].second); + } + }; + + FuzzJitThumb(1, 1, 10000, instruction_select); +} + +TEST_CASE("Fuzz Thumb instructions set 3 (32-bit BL/BLX)", "[JitX64][Thumb]") { + auto instruction_select = [&](int i) -> u16 { + std::pair inst_info; + if (i == 0) { + // BL / BLX prefix + inst_info = FromBitString16("11110xxxxxxxxxxx"); + } else { + // BL / BLX suffix + inst_info = RandInt(0, 1) ? FromBitString16("11101xxxxxxxxxx0") : FromBitString16("11111xxxxxxxxxxx"); + } + + u16 random = RandInt(0, 0xFFFF); + + return inst_info.first | (random &~ inst_info.second); + }; + + FuzzJitThumb(2, 2, 1000, instruction_select); +} diff --git a/src/tests/core/arm/jit_x64/rand_int.h b/src/tests/core/arm/jit_x64/rand_int.h new file mode 100644 index 000000000..5fd431452 --- /dev/null +++ b/src/tests/core/arm/jit_x64/rand_int.h @@ -0,0 +1,20 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#pragma once + +#include +#include + +template +T RandInt(T min, T max) { + static_assert(std::is_integral::value, "T must be an integral type."); + static_assert(!std::is_same::value && !std::is_same::value, + "Using char with uniform_int_distribution is undefined behavior."); + + static std::random_device rd; + static std::mt19937 mt(rd()); + std::uniform_int_distribution rand(min, max); + return rand(mt); +} diff --git a/src/tests/tests.cpp b/src/tests/tests.cpp new file mode 100644 index 000000000..73978676f --- /dev/null +++ b/src/tests/tests.cpp @@ -0,0 +1,9 @@ +// Copyright 2016 Citra Emulator Project +// Licensed under GPLv2 or any later version +// Refer to the license.txt file included. + +#define CATCH_CONFIG_MAIN +#include + +// Catch provides the main function since we've given it the +// CATCH_CONFIG_MAIN preprocessor directive.