From 03aea040cc0c07f9e510d8c9ae7a4e7e0b9edca8 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Thu, 30 Jun 2016 13:22:44 +1000 Subject: [PATCH 01/28] WIP Refactor comms --- CMakeLists.txt | 19 +- external/catch/catch.hpp | 10509 ++++++++++++++++++++++++++++++++ external/cppzmq/zmq.hpp | 66 +- external/cppzmq/zmq_addon.hpp | 465 ++ proto/CMakeLists.txt | 3 + proto/messages.proto | 27 + src/app/CMakeLists.txt | 1 - src/app/serverwrapper.cpp | 2 +- src/app/workerwrapper.cpp | 89 - src/app/workerwrapper.hpp | 47 - src/bin/CMakeLists.txt | 9 - src/bin/demo-worker.cpp | 93 - src/common/meta.hpp | 69 + src/common/string.hpp | 51 - src/comms/CMakeLists.txt | 6 +- src/comms/clientheartbeat.cpp | 113 - src/comms/clientheartbeat.hpp | 58 - src/comms/datatypes.hpp | 18 +- src/comms/delegator.cpp | 434 +- src/comms/delegator.hpp | 224 +- src/comms/endpoint.hpp | 78 + src/comms/handler.hpp | 34 - src/comms/heartbeat.cpp | 91 + src/comms/heartbeat.hpp | 71 + src/comms/message.cpp | 17 + src/comms/message.hpp | 59 + src/comms/messages.cpp | 72 - src/comms/messages.hpp | 101 - src/comms/minion.cpp | 57 - src/comms/minion.hpp | 70 - src/comms/poll.hpp | 77 + src/comms/protobuf.hpp | 23 + src/comms/requester.cpp | 84 +- src/comms/requester.hpp | 91 +- src/comms/router.cpp | 80 - src/comms/router.hpp | 125 +- src/comms/serverheartbeat.hpp | 2 +- src/comms/settings.hpp | 2 +- src/comms/socket.cpp | 275 +- src/comms/socket.hpp | 101 +- src/comms/supervisor.cpp | 116 + src/comms/supervisor.hpp | 59 + src/comms/worker.cpp | 139 +- src/comms/worker.hpp | 81 +- src/test/CMakeLists.txt | 34 +- src/test/endpoint.cpp | 69 + src/test/heartbeat.cpp | 28 + src/test/main.cpp | 9 +- src/test/message.cpp | 80 - src/test/poll.cpp | 99 + src/test/requester.cpp | 78 + src/test/router.cpp | 132 +- src/test/socket.cpp | 103 +- src/test/transport.cpp | 113 - 54 files changed, 12856 insertions(+), 2097 deletions(-) create mode 100644 external/catch/catch.hpp mode change 100755 => 100644 external/cppzmq/zmq.hpp create mode 100644 external/cppzmq/zmq_addon.hpp create mode 100644 proto/CMakeLists.txt create mode 100644 proto/messages.proto delete mode 100644 src/app/workerwrapper.cpp delete mode 100644 src/app/workerwrapper.hpp delete mode 100644 src/bin/demo-worker.cpp create mode 100644 src/common/meta.hpp delete mode 100644 src/common/string.hpp delete mode 100644 src/comms/clientheartbeat.cpp delete mode 100644 src/comms/clientheartbeat.hpp create mode 100644 src/comms/endpoint.hpp delete mode 100644 src/comms/handler.hpp create mode 100644 src/comms/heartbeat.cpp create mode 100644 src/comms/heartbeat.hpp create mode 100644 src/comms/message.cpp create mode 100644 src/comms/message.hpp delete mode 100644 src/comms/messages.cpp delete mode 100644 src/comms/messages.hpp delete mode 100644 src/comms/minion.cpp delete mode 100644 src/comms/minion.hpp create mode 100644 src/comms/poll.hpp create mode 100644 src/comms/protobuf.hpp delete mode 100644 src/comms/router.cpp create mode 100644 src/comms/supervisor.cpp create mode 100644 src/comms/supervisor.hpp create mode 100644 src/test/endpoint.cpp create mode 100644 src/test/heartbeat.cpp delete mode 100644 src/test/message.cpp create mode 100644 src/test/poll.cpp create mode 100644 src/test/requester.cpp delete mode 100644 src/test/transport.cpp diff --git a/CMakeLists.txt b/CMakeLists.txt index b2c785d..6577eb5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,7 +9,7 @@ # CMAKE SETUP ############################################################################## -CMAKE_MINIMUM_REQUIRED(VERSION 3.0) +CMAKE_MINIMUM_REQUIRED(VERSION 3.1) PROJECT(STATELINE LANGUAGES CXX) # Use folders @@ -42,6 +42,9 @@ ENDIF(LOCAL_INSTALL) # COMPILATION ############################################################################## +SET(CMAKE_CXX_STANDARD_REQUIRED ON) +SET(CMAKE_CXX_STANDARD 14) + SET(sl_flags "-D_GLIBCXX_USE_NANOSLEEP -std=c++11 -fPIC") SET(sl_warnings "-Wall -Wno-unused-local-typedefs -Wextra -pedantic") SET(sl_debug "-ggdb -g") @@ -75,11 +78,16 @@ FIND_PACKAGE(ZMQ REQUIRED) # Eigen FIND_PACKAGE(Eigen3 3.2.0 REQUIRED) +# Protobuf +FIND_PACKAGE(Protobuf REQUIRED) + ############################################################################## # INCLUDE DIRECTORIES ############################################################################## INCLUDE_DIRECTORIES("${STATELINE_SOURCE_DIR}/src" + SYSTEM "${PROTOBUF_INCLUDE_DIR}" + SYSTEM "${CMAKE_CURRENT_BINARY_DIR}" SYSTEM "${STATELINE_SOURCE_DIR}/external" SYSTEM "${STATELINE_SOURCE_DIR}/external/cppzmq" SYSTEM "${STATELINE_SOURCE_DIR}/external/json" @@ -87,6 +95,7 @@ INCLUDE_DIRECTORIES("${STATELINE_SOURCE_DIR}/src" SYSTEM "${ZMQ_INCLUDE_DIR}" SYSTEM "${EIGEN3_INCLUDE_DIR}") +ADD_SUBDIRECTORY(proto) ADD_SUBDIRECTORY(src/test) ############################################################################## @@ -129,11 +138,17 @@ ADD_LIBRARY(statelineserver STATIC #SHARED $ $ $ $ $ $) + TARGET_LINK_LIBRARIES(statelineserver ${Boost_LIBRARIES} ${ZMQ_LIBRARY}) SET_TARGET_PROPERTIES(statelineserver PROPERTIES LINKER_LANGUAGE CXX) +ADD_LIBRARY(stateline-server STATIC + $ + $ $) +TARGET_LINK_LIBRARIES(stateline-server proto ${ZMQ_LIBRARY} ${PROTOBUF_LIBRARY}) + ADD_LIBRARY(statelineclient STATIC #SHARED - $ $ + $ $ $) TARGET_LINK_LIBRARIES(statelineclient ${ZMQ_LIBRARY}) SET_TARGET_PROPERTIES(statelineclient PROPERTIES LINKER_LANGUAGE CXX) diff --git a/external/catch/catch.hpp b/external/catch/catch.hpp new file mode 100644 index 0000000..879fc5b --- /dev/null +++ b/external/catch/catch.hpp @@ -0,0 +1,10509 @@ +/* + * Catch v1.5.6 + * Generated: 2016-06-09 19:20:41.460328 + * ---------------------------------------------------------- + * 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 + +#ifdef __cplusplus + +# if __cplusplus >= 201103L +# define CATCH_CPP11_OR_GREATER +# endif + +# if __cplusplus >= 201402L +# define CATCH_CPP14_OR_GREATER +# endif + +#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 && !!(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 { + CATCH_AUTO_PTR( StreamBufBase ) 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; + + CATCH_AUTO_PTR( IStream const ) 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.2.4 + +// 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 + +#if defined(WIN32) || defined(__WIN32__) || defined(_WIN32) || defined(_MSC_VER) +#define CLARA_PLATFORM_WINDOWS +#endif + +// 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 + + 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 + "'" ); + } + + 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 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 ); + } + 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 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 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 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 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 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 bool takesArg() const { return !IsBool::value; } + virtual IArgFunction* clone() const { return new BoundBinaryFunction( *this ); } + void (*function)( C&, T ); + }; + + } // namespace Detail + + inline std::vector argsToVector( int argc, char const* const* const argv ) { + std::vector args( static_cast( argc ) ); + for( std::size_t i = 0; i < static_cast( argc ); ++i ) + args[i] = argv[i]; + + return args; + } + + class Parser { + enum Mode { None, MaybeShortOpt, SlashOpt, ShortOpt, LongOpt, Positional }; + Mode mode; + std::size_t from; + bool inQuotes; + public: + + struct Token { + enum Type { Positional, ShortOpt, LongOpt }; + Token( Type _type, std::string const& _data ) : type( _type ), data( _data ) {} + Type type; + std::string data; + }; + + Parser() : mode( None ), from( 0 ), inQuotes( false ){} + + void parseIntoTokens( std::vector const& args, std::vector& tokens ) { + const std::string doubleDash = "--"; + for( std::size_t i = 1; i < args.size() && args[i] != doubleDash; ++i ) + parseIntoTokens( args[i], tokens); + } + + void parseIntoTokens( std::string const& arg, std::vector& tokens ) { + for( std::size_t i = 0; i <= arg.size(); ++i ) { + char c = arg[i]; + if( c == '"' ) + inQuotes = !inQuotes; + mode = handleMode( i, c, arg, tokens ); + } + } + Mode handleMode( std::size_t i, char c, std::string const& arg, std::vector& tokens ) { + switch( mode ) { + case None: return handleNone( i, c ); + case MaybeShortOpt: return handleMaybeShortOpt( i, c ); + case ShortOpt: + case LongOpt: + case SlashOpt: return handleOpt( i, c, arg, tokens ); + case Positional: return handlePositional( i, c, arg, tokens ); + default: throw std::logic_error( "Unknown mode" ); + } + } + + Mode handleNone( std::size_t i, char c ) { + if( inQuotes ) { + from = i; + return Positional; + } + switch( c ) { + case '-': return MaybeShortOpt; +#ifdef CLARA_PLATFORM_WINDOWS + case '/': from = i+1; return SlashOpt; +#endif + default: from = i; return Positional; + } + } + Mode handleMaybeShortOpt( std::size_t i, char c ) { + switch( c ) { + case '-': from = i+1; return LongOpt; + default: from = i; return ShortOpt; + } + } + Mode handleOpt( std::size_t i, char c, std::string const& arg, std::vector& tokens ) { + if( std::string( ":=\0", 3 ).find( c ) == std::string::npos ) + return mode; + + std::string optName = arg.substr( from, i-from ); + if( mode == ShortOpt ) + for( std::size_t j = 0; j < optName.size(); ++j ) + tokens.push_back( Token( Token::ShortOpt, optName.substr( j, 1 ) ) ); + else if( mode == SlashOpt && optName.size() == 1 ) + tokens.push_back( Token( Token::ShortOpt, optName ) ); + else + tokens.push_back( Token( Token::LongOpt, optName ) ); + return None; + } + Mode handlePositional( std::size_t i, char c, std::string const& arg, std::vector& tokens ) { + if( inQuotes || std::string( "\0", 1 ).find( c ) == std::string::npos ) + return mode; + + std::string data = arg.substr( from, i-from ); + tokens.push_back( Token( Token::Positional, data ) ); + return None; + } + }; + + 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( std::vector const& args ) const { + ConfigT config; + parseInto( args, config ); + return config; + } + + std::vector parseInto( std::vector const& args, ConfigT& config ) const { + std::string processName = args[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( args, 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.set( config, "true" ); + } + 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; + }; + + class MultipleReporters; + + 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; + + virtual MultipleReporters* tryAsMulti() { return CATCH_NULL; } + }; + + 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; + + // Debug/ checking + virtual bool isSectionTracker() const = 0; + virtual bool isIndexTracker() const = 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(); + } + } + + virtual bool isSectionTracker() const CATCH_OVERRIDE { return false; } + virtual bool isIndexTracker() const CATCH_OVERRIDE { return false; } + + 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(); + + virtual bool isSectionTracker() const CATCH_OVERRIDE { return true; } + + static SectionTracker& acquire( TrackerContext& ctx, std::string const& name ) { + SectionTracker* section = CATCH_NULL; + + ITracker& currentTracker = ctx.currentTracker(); + if( ITracker* childTracker = currentTracker.findChild( name ) ) { + assert( childTracker ); + assert( childTracker->isSectionTracker() ); + section = static_cast( childTracker ); + } + 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(); + + virtual bool isIndexTracker() const CATCH_OVERRIDE { return true; } + + 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 ) ) { + assert( childTracker ); + assert( childTracker->isIndexTracker() ); + tracker = static_cast( childTracker ); + } + 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* const* const argv, OnUnusedOptions::DoWhat unusedOptionBehaviour = OnUnusedOptions::Fail ) { + try { + m_cli.setThrowOnUnrecognisedTokens( unusedOptionBehaviour == OnUnusedOptions::Fail ); + m_unusedTokens = m_cli.parseInto( Clara::argsToVector( 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* const* const argv ) { + + int returnCode = applyCommandLine( argc, argv ); + if( returnCode == 0 ) + returnCode = run(); + return returnCode; + } + + 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 + +#ifdef CATCH_CPP14_OR_GREATER +#include +#endif + +namespace Catch { + + struct RandomNumberGenerator { + typedef int result_type; + + result_type operator()( result_type n ) const { return std::rand() % n; } + +#ifdef CATCH_CPP14_OR_GREATER + static constexpr result_type min() { return 0; } + static constexpr result_type max() { return 1000000; } + result_type operator()() const { return std::rand() % max(); } +#endif + template + static void shuffle( V& vector ) { + RandomNumberGenerator rng; +#ifdef CATCH_CPP14_OR_GREATER + std::shuffle( vector.begin(), vector.end(), rng ); +#else + std::random_shuffle( vector.begin(), vector.end(), rng ); +#endif + } + }; + + inline std::vector sortTests( IConfig const& config, std::vector const& unsortedTestCases ) { + + std::vector sorted = unsortedTestCases; + + switch( config.runOrder() ) { + case RunTests::InLexicographicalOrder: + std::sort( sorted.begin(), sorted.end() ); + break; + case RunTests::InRandomOrder: + { + seedRng( config ); + RandomNumberGenerator::shuffle( sorted ); + } + 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 ) { + std::ostringstream ss; + + ss << 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; + + throw std::runtime_error(ss.str()); + } + } + } + + 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, 5, 6, "", 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 ); + } + + virtual MultipleReporters* tryAsMulti() CATCH_OVERRIDE { + return this; + } + +}; + +Ptr addReporter( Ptr const& existingReporter, Ptr const& additionalReporter ) { + Ptr resultingReporter; + + if( existingReporter ) { + MultipleReporters* multi = existingReporter->tryAsMulti(); + 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 ) CATCH_OVERRIDE { + 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/external/cppzmq/zmq.hpp b/external/cppzmq/zmq.hpp old mode 100755 new mode 100644 index daacfc5..4fcb928 --- a/external/cppzmq/zmq.hpp +++ b/external/cppzmq/zmq.hpp @@ -86,6 +86,12 @@ typedef struct { } zmq_event_t; #endif +// Avoid using deprecated message receive function when possible +#if ZMQ_VERSION < ZMQ_MAKE_VERSION(3, 2, 0) +# define zmq_msg_recv(msg, socket, flags) zmq_recvmsg(socket, msg, flags) +#endif + + // In order to prevent unused variable warnings when building in non-debug // mode use this macro to make assertions. #ifndef NDEBUG @@ -121,9 +127,9 @@ namespace zmq int errnum; }; - inline int poll (zmq_pollitem_t const* items_, int nitems_, long timeout_ = -1) + inline int poll (zmq_pollitem_t const* items_, size_t nitems_, long timeout_ = -1) { - int rc = zmq_poll (const_cast(items_), nitems_, timeout_); + int rc = zmq_poll (const_cast(items_), static_cast(nitems_), timeout_); if (rc < 0) throw error_t (); return rc; @@ -131,7 +137,7 @@ namespace zmq inline int poll(zmq_pollitem_t const* items, size_t nitems) { - return poll(items, static_cast(nitems), -1); + return poll(items, nitems, -1); } #ifdef ZMQ_CPP11 @@ -147,7 +153,7 @@ namespace zmq inline int poll(std::vector const& items, long timeout_ = -1) { - return poll(items.data(), static_cast(items.size()), timeout_); + return poll(items.data(), items.size(), timeout_); } #endif @@ -207,13 +213,26 @@ namespace zmq msg() { typedef typename std::iterator_traits::difference_type size_type; - typedef typename std::iterator_traits::pointer pointer_t; + typedef typename std::iterator_traits::value_type value_t; - size_type const size_ = std::distance(first, last); + size_type const size_ = std::distance(first, last)*sizeof(value_t); int const rc = zmq_msg_init_size (&msg, size_); if (rc != 0) throw error_t (); - std::copy(first, last, static_cast(zmq_msg_data (&msg)) ); + value_t* dest = data(); + while (first != last) + { + *dest = *first; + ++dest; ++first; + } + } + + inline message_t (const void *data_, size_t size_) + { + int rc = zmq_msg_init_size (&msg, size_); + if (rc != 0) + throw error_t (); + memcpy(data(), data_, size_); } inline message_t (void *data_, size_t size_, free_fn *ffn_, @@ -265,6 +284,17 @@ namespace zmq throw error_t (); } + inline void rebuild (const void *data_, size_t size_) + { + int rc = zmq_msg_close (&msg); + if (rc != 0) + throw error_t (); + rc = zmq_msg_init_size (&msg, size_); + if (rc != 0) + throw error_t (); + memcpy(data(), data_, size_); + } + inline void rebuild (void *data_, size_t size_, free_fn *ffn_, void *hint_ = NULL) { @@ -321,6 +351,14 @@ namespace zmq return static_cast( data() ); } + inline bool equal(const message_t* other) const ZMQ_NOTHROW + { + if (size() != other->size()) + return false; + std::string a(data(), size()); + std::string b(other->data(), other->size()); + return a == b; + } private: // The underlying message @@ -372,16 +410,14 @@ namespace zmq inline ~context_t () ZMQ_NOTHROW { - close(); + int rc = zmq_ctx_destroy (ptr); + ZMQ_ASSERT (rc == 0); } inline void close() ZMQ_NOTHROW { - if (ptr == NULL) - return; int rc = zmq_ctx_destroy (ptr); ZMQ_ASSERT (rc == 0); - ptr = NULL; } // Be careful with this, it's probably only useful for @@ -493,14 +529,14 @@ namespace zmq } inline void getsockopt (int option_, void *optval_, - size_t *optvallen_) + size_t *optvallen_) const { int rc = zmq_getsockopt (ptr, option_, optval_, optvallen_); if (rc != 0) throw error_t (); } - template T getsockopt(int option_) + template T getsockopt(int option_) const { T optval; size_t optlen = sizeof(T); @@ -659,7 +695,7 @@ namespace zmq while (true) { zmq_msg_t eventMsg; zmq_msg_init (&eventMsg); - rc = zmq_recvmsg (s, &eventMsg, 0); + rc = zmq_msg_recv (&eventMsg, s, 0); if (rc == -1 && zmq_errno() == ETERM) break; assert (rc != -1); @@ -676,7 +712,7 @@ namespace zmq #ifdef ZMQ_NEW_MONITOR_EVENT_LAYOUT zmq_msg_t addrMsg; zmq_msg_init (&addrMsg); - rc = zmq_recvmsg (s, &addrMsg, 0); + rc = zmq_msg_recv (&addrMsg, s, 0); if (rc == -1 && zmq_errno() == ETERM) break; assert (rc != -1); diff --git a/external/cppzmq/zmq_addon.hpp b/external/cppzmq/zmq_addon.hpp new file mode 100644 index 0000000..403f7ab --- /dev/null +++ b/external/cppzmq/zmq_addon.hpp @@ -0,0 +1,465 @@ +/* + Copyright (c) 2016 VOCA AS / Harald Nøkland + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to + deal in the Software without restriction, including without limitation the + rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + IN THE SOFTWARE. +*/ + +#ifndef __ZMQ_ADDON_HPP_INCLUDED__ +#define __ZMQ_ADDON_HPP_INCLUDED__ + +#include +#include +#include +#include + +namespace zmq { + +#ifdef ZMQ_HAS_RVALUE_REFS + +/* + This class handles multipart messaging. It is the C++ equivalent of zmsg.h, + which is part of CZMQ (the high-level C binding). Furthermore, it is a major + improvement compared to zmsg.hpp, which is part of the examples in the ØMQ + Guide. Unnecessary copying is avoided by using move semantics to efficiently + add/remove parts. +*/ +class multipart_t +{ +private: + std::deque m_parts; + +public: + multipart_t() + {} + + multipart_t(socket_t& socket) + { + recv(socket); + } + + multipart_t(const void *src, size_t size) + { + addmem(src, size); + } + + multipart_t(const std::string& string) + { + addstr(string); + } + + multipart_t(message_t&& message) + { + add(std::move(message)); + } + + multipart_t(multipart_t&& other) + { + std::swap(m_parts, other.m_parts); + } + + multipart_t& operator=(multipart_t&& other) + { + std::swap(m_parts, other.m_parts); + return *this; + } + + virtual ~multipart_t() + { + clear(); + } + + void clear() + { + m_parts.clear(); + } + + size_t size() const + { + return m_parts.size(); + } + + bool empty() const + { + return m_parts.empty(); + } + + bool recv(socket_t& socket) + { + clear(); + bool more = true; + while (more) + { + message_t message; + if (!socket.recv(&message)) + return false; + more = message.more(); + add(std::move(message)); + } + return true; + } + + bool send(socket_t& socket) + { + bool more = size() > 0; + while (more) + { + message_t message = pop(); + more = size() > 0; + if (!socket.send(message, more ? ZMQ_SNDMORE : 0)) + return false; + } + clear(); + return true; + } + + void prepend(multipart_t&& other) + { + while (!other.empty()) + push(other.remove()); + } + + void append(multipart_t&& other) + { + while (!other.empty()) + add(other.pop()); + } + + void pushmem(const void *src, size_t size) + { + m_parts.push_front(message_t(src, size)); + } + + void addmem(const void *src, size_t size) + { + m_parts.push_back(message_t(src, size)); + } + + void pushstr(const std::string& string) + { + m_parts.push_front(message_t(string.data(), string.size())); + } + + void addstr(const std::string& string) + { + m_parts.push_back(message_t(string.data(), string.size())); + } + + template + void pushtyp(const T& type) + { + m_parts.push_front(message_t(&type, sizeof(type))); + } + + template + void addtyp(const T& type) + { + m_parts.push_back(message_t(&type, sizeof(type))); + } + + void push(message_t&& message) + { + m_parts.push_front(std::move(message)); + } + + void add(message_t&& message) + { + m_parts.push_back(std::move(message)); + } + + std::string popstr() + { + if (m_parts.empty()) + return ""; + std::string string(m_parts.front().data(), m_parts.front().size()); + m_parts.pop_front(); + return string; + } + + template + T poptyp() + { + if (m_parts.empty()) + return T(); + T type = *m_parts.front().data(); + m_parts.pop_front(); + return type; + } + + message_t pop() + { + if (m_parts.empty()) + return message_t(0); + message_t message = std::move(m_parts.front()); + m_parts.pop_front(); + return message; + } + + message_t remove() + { + if (m_parts.empty()) + return message_t(0); + message_t message = std::move(m_parts.back()); + m_parts.pop_back(); + return message; + } + + const message_t* peek(size_t index) const + { + if (index >= size()) + return nullptr; + return &m_parts[index]; + } + + template + static multipart_t create(const T& type) + { + multipart_t multipart; + multipart.addtyp(type); + return multipart; + } + + multipart_t clone() const + { + multipart_t multipart; + for (size_t i = 0; i < size(); i++) + multipart.addmem(m_parts[i].data(), m_parts[i].size()); + return multipart; + } + + std::string str() const + { + std::stringstream ss; + for (size_t i = 0; i < m_parts.size(); i++) + { + const unsigned char* data = m_parts[i].data(); + size_t size = m_parts[i].size(); + + // Dump the message as text or binary + bool isText = true; + for (size_t j = 0; j < size; j++) + { + if (data[j] < 32 || data[j] > 127) + { + isText = false; + break; + } + } + ss << "\n[" << std::dec << std::setw(3) << std::setfill('0') << size << "] "; + if (size >= 1000) + { + ss << "... (to big to print)"; + continue; + } + for (size_t j = 0; j < size; j++) + { + if (isText) + ss << static_cast(data[j]); + else + ss << std::hex << std::setw(2) << std::setfill('0') << static_cast(data[j]); + } + } + return ss.str(); + } + + bool equal(const multipart_t* other) const + { + if (size() != other->size()) + return false; + for (size_t i = 0; i < size(); i++) + if (!peek(i)->equal(other->peek(i))) + return false; + return true; + } + + static int test() + { + bool ok = true; + float num = 0; + std::string str = ""; + message_t msg; + + // Create two PAIR sockets and connect over inproc + context_t context(1); + socket_t output(context, ZMQ_PAIR); + socket_t input(context, ZMQ_PAIR); + output.bind("inproc://multipart.test"); + input.connect("inproc://multipart.test"); + + // Test send and receive of single-frame message + multipart_t multipart; + assert(multipart.empty()); + + multipart.push(message_t("Hello", 5)); + assert(multipart.size() == 1); + + ok = multipart.send(output); + assert(multipart.empty()); + assert(ok); + + ok = multipart.recv(input); + assert(multipart.size() == 1); + assert(ok); + + msg = multipart.pop(); + assert(multipart.empty()); + assert(std::string(msg.data(), msg.size()) == "Hello"); + + // Test send and receive of multi-frame message + multipart.addstr("A"); + multipart.addstr("BB"); + multipart.addstr("CCC"); + assert(multipart.size() == 3); + + multipart_t copy = multipart.clone(); + assert(copy.size() == 3); + + ok = copy.send(output); + assert(copy.empty()); + assert(ok); + + ok = copy.recv(input); + assert(copy.size() == 3); + assert(ok); + assert(copy.equal(&multipart)); + + multipart.clear(); + assert(multipart.empty()); + + // Test message frame manipulation + multipart.add(message_t("Frame5", 6)); + multipart.addstr("Frame6"); + multipart.addstr("Frame7"); + multipart.addtyp(8.0f); + multipart.addmem("Frame9", 6); + multipart.push(message_t("Frame4", 6)); + multipart.pushstr("Frame3"); + multipart.pushstr("Frame2"); + multipart.pushtyp(1.0f); + multipart.pushmem("Frame0", 6); + assert(multipart.size() == 10); + + msg = multipart.remove(); + assert(multipart.size() == 9); + assert(std::string(msg.data(), msg.size()) == "Frame9"); + + msg = multipart.pop(); + assert(multipart.size() == 8); + assert(std::string(msg.data(), msg.size()) == "Frame0"); + + num = multipart.poptyp(); + assert(multipart.size() == 7); + assert(num == 1.0f); + + str = multipart.popstr(); + assert(multipart.size() == 6); + assert(str == "Frame2"); + + str = multipart.popstr(); + assert(multipart.size() == 5); + assert(str == "Frame3"); + + str = multipart.popstr(); + assert(multipart.size() == 4); + assert(str == "Frame4"); + + str = multipart.popstr(); + assert(multipart.size() == 3); + assert(str == "Frame5"); + + str = multipart.popstr(); + assert(multipart.size() == 2); + assert(str == "Frame6"); + + str = multipart.popstr(); + assert(multipart.size() == 1); + assert(str == "Frame7"); + + num = multipart.poptyp(); + assert(multipart.empty()); + assert(num == 8.0f); + + // Test message constructors and concatenation + multipart_t head("One", 3); + head.addstr("Two"); + assert(head.size() == 2); + + multipart_t tail("One-hundred"); + tail.pushstr("Ninety-nine"); + assert(tail.size() == 2); + + multipart_t tmp(message_t("Fifty", 5)); + assert(tmp.size() == 1); + + multipart_t mid = multipart_t::create(49.0f); + mid.append(std::move(tmp)); + assert(mid.size() == 2); + assert(tmp.empty()); + + multipart_t merged(std::move(mid)); + merged.prepend(std::move(head)); + merged.append(std::move(tail)); + assert(merged.size() == 6); + assert(head.empty()); + assert(tail.empty()); + + ok = merged.send(output); + assert(merged.empty()); + assert(ok); + + multipart_t received(input); + assert(received.size() == 6); + + str = received.popstr(); + assert(received.size() == 5); + assert(str == "One"); + + str = received.popstr(); + assert(received.size() == 4); + assert(str == "Two"); + + num = received.poptyp(); + assert(received.size() == 3); + assert(num == 49.0f); + + str = received.popstr(); + assert(received.size() == 2); + assert(str == "Fifty"); + + str = received.popstr(); + assert(received.size() == 1); + assert(str == "Ninety-nine"); + + str = received.popstr(); + assert(received.empty()); + assert(str == "One-hundred"); + + return 0; + } + +private: + // Disable implicit copying (moving is more efficient) + multipart_t(const multipart_t& other) ZMQ_DELETED_FUNCTION; + void operator=(const multipart_t& other) ZMQ_DELETED_FUNCTION; +}; + +#endif + +} + +#endif diff --git a/proto/CMakeLists.txt b/proto/CMakeLists.txt new file mode 100644 index 0000000..d5bd08b --- /dev/null +++ b/proto/CMakeLists.txt @@ -0,0 +1,3 @@ +INCLUDE_DIRECTORIES(${PROTOBUF_INCLUDE_DIR}) +PROTOBUF_GENERATE_CPP(PROTO_SRC PROTO_HEADER messages.proto) +ADD_LIBRARY(proto ${PROTO_HEADER} ${PROTO_SRC}) diff --git a/proto/messages.proto b/proto/messages.proto new file mode 100644 index 0000000..7ba8281 --- /dev/null +++ b/proto/messages.proto @@ -0,0 +1,27 @@ +package messages; + +message Heartbeat { + // Empty message +} + +message Job { + required uint32 id = 1; // Job ID + optional uint32 job_type = 2; // Job type + repeated double data = 3; // Job data +} + +message Result { + required uint32 id = 1; // Job ID + optional double data = 2; // Result data +} + +message BatchJob { + required uint32 id = 1; // Batch ID + repeated uint32 job_type = 2; // Job types this request uses + repeated double data = 3; // Job data +} + +message BatchResult { + required uint32 id = 1; // Batch ID + repeated double data = 2; // Result data +} diff --git a/src/app/CMakeLists.txt b/src/app/CMakeLists.txt index 8406276..f055487 100644 --- a/src/app/CMakeLists.txt +++ b/src/app/CMakeLists.txt @@ -6,5 +6,4 @@ # Date: 2014 ADD_LIBRARY(commonwrapper OBJECT logging.cpp signal.cpp) -ADD_LIBRARY(workerwrapper OBJECT workerwrapper.cpp) ADD_LIBRARY(serverwrapper OBJECT serverwrapper.cpp api.cpp) diff --git a/src/app/serverwrapper.cpp b/src/app/serverwrapper.cpp index 0d5c18e..a2a1d50 100644 --- a/src/app/serverwrapper.cpp +++ b/src/app/serverwrapper.cpp @@ -9,7 +9,7 @@ namespace stateline { void updateWorkerApi(ApiResources& api, comms::Delegator& delegator) { - api.set("workers", json({{ "count", delegator.workerCount() }})); + //api.set("workers", json({{ "count", delegator.workerCount() }})); } } diff --git a/src/app/workerwrapper.cpp b/src/app/workerwrapper.cpp deleted file mode 100644 index 8199d84..0000000 --- a/src/app/workerwrapper.cpp +++ /dev/null @@ -1,89 +0,0 @@ -//! -//! Main entry point for using stateline -- worker side -//! -//! -//! -//! \file app/workerwrapper.cpp -//! \author Lachlan McCalman -//! \date 2015 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2015, NICTA -//! - -#include "workerwrapper.hpp" -#include "comms/minion.hpp" -#include "comms/worker.hpp" -#include "comms/thread.hpp" - -#include -#include - -namespace stateline -{ - -void runMinion(const LikelihoodFn& lhFn, const std::pair& jobTypesRange, - zmq::context_t& context, const std::string& workerSocketAddr, bool& running) -{ - comms::Minion minion(context, jobTypesRange, workerSocketAddr); - while (running) - { - const auto job = minion.nextJob(); - const auto& jobType = job.first; - const auto& sample = job.second; - double nll = lhFn(jobType,sample); - minion.submitResult(nll); - } -} - -std::string generateRandomIPCAddr() -{ - std::random_device rd; - std::mt19937 gen(rd()); - std::uniform_int_distribution<> dis(0, 0x1000000); - std::ostringstream oss; - oss << "ipc:///tmp/sl_worker_" - << std::hex << std::uppercase << std::setw(6) << std::setfill('0') << dis(gen) - << ".socket"; - return oss.str(); -} - -WorkerWrapper::WorkerWrapper(const LikelihoodFn& f, const std::pair& jobTypesRange, - const std::string& address) - : lhFn_(f) - , jobTypesRange_(jobTypesRange) - , settings_(comms::WorkerSettings::Default(address, generateRandomIPCAddr())) -{ -} - - -void WorkerWrapper::start() -{ - context_ = new zmq::context_t{1}; - running_ = true; - - clientThread_ = startInThread(std::ref(running_), std::ref(*context_), - std::cref(settings_)); - - minionThread_ = std::async(std::launch::async, runMinion, std::cref(lhFn_), - std::cref(jobTypesRange_), std::ref(*context_), - std::cref(settings_.workerAddress), std::ref(running_)); -} - -void WorkerWrapper::stop() -{ - running_ = false; - if (context_) - { - delete context_; - context_ = nullptr; //THIS MUST BE DONE - } - clientThread_.wait(); - minionThread_.wait(); -} - -WorkerWrapper::~WorkerWrapper() -{ - stop(); -} - -} diff --git a/src/app/workerwrapper.hpp b/src/app/workerwrapper.hpp deleted file mode 100644 index b29f4c7..0000000 --- a/src/app/workerwrapper.hpp +++ /dev/null @@ -1,47 +0,0 @@ -//! -//! Main entry point for using stateline -- worker side -//! -//! -//! -//! \file app/workerwrapper.hpp -//! \author Lachlan McCalman -//! \date 2015 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2015, NICTA -//! - -#include "../comms/settings.hpp" - -#include -#include -#include - -namespace stateline -{ - typedef std::function&)> LikelihoodFn; - - class WorkerWrapper - { - public: - WorkerWrapper(const LikelihoodFn& f, const std::pair& jobTypesRange, - const std::string& address); - - ~WorkerWrapper(); - void start(); - void stop(); - - private: - - const LikelihoodFn lhFn_; - std::pair jobTypesRange_; - - comms::WorkerSettings settings_; - - bool running_; - zmq::context_t* context_; - - std::future clientThread_; - std::future minionThread_; - }; -} - diff --git a/src/bin/CMakeLists.txt b/src/bin/CMakeLists.txt index 6e085c3..0b50a7d 100644 --- a/src/bin/CMakeLists.txt +++ b/src/bin/CMakeLists.txt @@ -30,12 +30,3 @@ ENDFUNCTION() ADD_BINARY(stateline-client statelineclient) ADD_BINARY(stateline statelineserver) -ADD_BINARY(demo-worker statelineclient) - -# Copy over demo files -COPY_FILE(demo-config.json) -COPY_FILE(demo-worker.py) -COPY_FILE(vis.py) - -# Create demo output directories -FILE(MAKE_DIRECTORY ${STATELINE_BINARY_DIR}/demo-output) diff --git a/src/bin/demo-worker.cpp b/src/bin/demo-worker.cpp deleted file mode 100644 index 4c82147..0000000 --- a/src/bin/demo-worker.cpp +++ /dev/null @@ -1,93 +0,0 @@ -//! -//! A demo using Stateline to sample from a Gaussian mixture. -//! -//! This file aims to be a tutorial on setting up a MCMC simulation using -//! the C++ worker API of Stateline. -//! -//! \file demoWorker.cpp -//! \author Lachlan McCalman -//! \author Darren Shen -//! \date 2014 -//! \licence Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include -#include -#include "ezoptionparser/ezOptionParser.hpp" - -#include "../app/commandline.hpp" -#include "../app/signal.hpp" -#include "../app/logging.hpp" -#include "../app/workerwrapper.hpp" - -namespace sl = stateline; - -ez::ezOptionParser commandLineOptions() -{ - ez::ezOptionParser opt; - opt.overview = "Demo options"; - opt.add("", 0, 0, 0, "Print help message", "-h", "--help"); - opt.add("0", 0, 1, 0, "Logging level", "-l", "--log-level"); - opt.add("localhost:5555", 0, 1, 0, "Address of server", "-a", "--address"); - opt.add("3", 0, 1, 0, "Number of job types", "-j", "--job-types"); - return opt; -} - -double gaussianNLL(uint /*jobType*/, const std::vector& x) -{ - double squaredNorm = 0.0; - for (auto i : x) - { - squaredNorm += i*i; - } - return 0.5*squaredNorm; -} - - -int main(int argc, const char *argv[]) -{ - // Parse the command line - auto opt = commandLineOptions(); - if (!sl::parseCommandLine(opt, argc, argv)) - return 0; - - // Initialise logging - int logLevel; - opt.get("-l")->getInt(logLevel); - sl::initLogging(logLevel); - - // Capture Ctrl+C - sl::init::initialiseSignalHandler(); - - // Initialise the worker wrapper - std::string address; - opt.get("-a")->getString(address); - - int numJobTypes; - opt.get("-j")->getInt(numJobTypes); - - sl::WorkerWrapper w(gaussianNLL, {0, numJobTypes}, address); - - /* - NB: For multiple likelihood functions WorkerWrapper can be initialised with an array, e.g.: - sl::JobLikelihoodFnMap lhMap = { gaussianNLL }; - sl::WorkerWrapper w(lhMap, 0, address); - - or a function, e.g.: - const sl::LikelihoodFn& lh = gaussianNLL; - sl::JobToLikelihoodFnFn f = [&lh](const std::string&) -> const sl::LikelihoodFn& { return lh; }; - sl::WorkerWrapper w(f, {"job"}, address); - */ - - w.start(); - - while(!sl::global::interruptedBySignal) - { - std::this_thread::sleep_for(std::chrono::milliseconds(500)); - } - - w.stop(); - - return 0; -} diff --git a/src/common/meta.hpp b/src/common/meta.hpp new file mode 100644 index 0000000..e3f688e --- /dev/null +++ b/src/common/meta.hpp @@ -0,0 +1,69 @@ +//! Common meta-programming helpers. +//! +//! \file common/meta.hpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include +#include +#include + +namespace stateline { + +namespace meta { + +template struct seq {}; +template struct gen_seq : gen_seq {}; +template struct gen_seq<0, Is...> : seq {}; + +// Inspired by http://stackoverflow.com/questions/21062864/optimal-way-to-access-stdtuple-element-in-runtime-by-index + +namespace detail +{ + template + Ret apply_one(T& p, F func) { return func(std::get(p)); } + + template + Ret apply(T& p, int index, F func, seq) + { + using FT = Ret(T&, F); + static constexpr FT* ftable[] = { &apply_one... }; + + assert(index < sizeof...(Is)); + return ftable[index](p, func); + } +} + +template +Ret apply(T& p, std::size_t index, F func) +{ + return detail::apply(p, index, func, gen_seq::value>{}); +} + +// From http://stackoverflow.com/questions/16387354/template-tuple-calling-a-function-on-each-element +namespace detail +{ + +template +void apply_all_impl(T&& t, F func, seq) +{ + std::initializer_list l = { (func(std::get(t)), 0)... }; + (void)l; +} + +} + +template +void apply_all(const std::tuple& t, F func) +{ + detail::apply_all_impl(t, func, gen_seq()); +} + +} // namespace meta + +} // namespace stateline diff --git a/src/common/string.hpp b/src/common/string.hpp deleted file mode 100644 index 1c969fb..0000000 --- a/src/common/string.hpp +++ /dev/null @@ -1,51 +0,0 @@ -//! -//! String algorithms. -//! -//! \file common/string.hpp -//! \author Darren Shen -//! \date 2016 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include - -namespace stateline -{ - -template -std::string joinStr(const Container& container, const std::string& delim) -{ - std::string result; - for (const auto& v : container) - { - result += v + delim; - } - result.pop_back(); // Remove last delimiter - return result; -} - -template -void splitStr(OutputContainer& out, const std::string& str, char delim) -{ - std::string segment; - for (const auto& c : str) - { - if (c == delim) - { - out.insert(std::end(out), segment); - segment = ""; - } - else - { - segment += c; - } - } - - if (segment != "") - out.insert(std::end(out), segment); -} - -} diff --git a/src/comms/CMakeLists.txt b/src/comms/CMakeLists.txt index fbcacae..4f9a6f5 100644 --- a/src/comms/CMakeLists.txt +++ b/src/comms/CMakeLists.txt @@ -5,6 +5,6 @@ # Authors: Lachlan McCalman # Date: 2014 -ADD_LIBRARY(commoncomms OBJECT messages.cpp router.cpp socket.cpp) -ADD_LIBRARY(servercomms OBJECT serverheartbeat.cpp delegator.cpp requester.cpp) -ADD_LIBRARY(clientcomms OBJECT clientheartbeat.cpp worker.cpp minion.cpp) +ADD_LIBRARY(commoncomms OBJECT message.cpp socket.cpp heartbeat.cpp) +ADD_LIBRARY(servercomms OBJECT requester.cpp) +ADD_LIBRARY(clientcomms OBJECT worker.cpp) diff --git a/src/comms/clientheartbeat.cpp b/src/comms/clientheartbeat.cpp deleted file mode 100644 index 6fe01c8..0000000 --- a/src/comms/clientheartbeat.cpp +++ /dev/null @@ -1,113 +0,0 @@ -//! -//! Implementation of heartbeat routers that deal with client heartbeating -//! sending and receiving. -//! -//! \file comms/clientheartbeat.cpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "comms/clientheartbeat.hpp" -#include -#include -#include "comms/settings.hpp" - -namespace stateline -{ - namespace comms - { - //! Update book-keeping on server heartbeats. Called every time the socket is polled. - //! - //! \param lastReceivedTime The time that the client last received a heartbeat from the server. - //! \param router A reference to the socket router. - //! \param msTimeout The heartbeat timeout in milliseconds. - //! - // void monitorTimeout(hrc::time_point& lastReceivedTime, Socket& socket, uint msTimeout, bool& running); - - //! Update book-keeping on server heartbeats. Called when the socket receives a heartbeat from the server. - //! - //! \param lastReceivedTime The time that the client last received a heartbeat from the server. - //! - void heartbeatArrived(hrc::time_point& lastReceivedTime); - - //! Send a heartbeat to the server if necessary. - //! - //! \param lastSendTime The last time this client sent a heartbeat. - //! \param router A reference to the socket router. - //! \param msFrequency The number of milliseconds between each heartbeat. - //! - void sendHeartbeat(hrc::time_point& lastSendTime, Socket& socket, uint msFrequency); - - ClientHeartbeat::ClientHeartbeat(zmq::context_t& context, const HeartbeatSettings& settings, bool& running) - : socket_(context, ZMQ_PAIR, "toClient"), - router_("HB", { &socket_ }), - msPollRate_(settings.msPollRate), - running_(running) - { - socket_.connect(CLIENT_HB_SOCKET_ADDR); - - // Specify functionality - auto rcvHeartbeat = [&](const Message&) { heartbeatArrived(lastReceivedTime_); }; - auto rcvGoodbye = [&](const Message&) { running_ = false;}; - - auto onPoll = [&]() - { - // monitorTimeout(lastReceivedTime_, socket_, settings.msTimeout, running_); - sendHeartbeat(lastSendTime_, socket_, settings.msRate); - }; - - // Bind to router - const uint CLIENT_SOCKET = 0; - - router_.bind(CLIENT_SOCKET, HEARTBEAT, rcvHeartbeat); - router_.bind(CLIENT_SOCKET, GOODBYE, rcvGoodbye); - router_.bindOnPoll(onPoll); - } - - void ClientHeartbeat::start() - { - lastSendTime_ = std::chrono::high_resolution_clock::now(); - lastReceivedTime_ = std::chrono::high_resolution_clock::now(); - router_.poll(msPollRate_, running_); // milliseconds between polling loops - } - - ClientHeartbeat::~ClientHeartbeat() - { - } - - // TODO: why not just make these member functions? - // void monitorTimeout(hrc::time_point& lastReceivedTime, Socket& socket, uint msTimeout, bool& running) - // { - // auto msElapsed = std::chrono::duration_cast(hrc::now() - lastReceivedTime).count(); - // if (msElapsed > msTimeout) - // { - // VLOG(1) << "Heartbeat system sending GOODBYE on behalf of server"; - // socket.send({ stateline::comms::GOODBYE }); - // running = false; - // } - // } - - void heartbeatArrived(hrc::time_point& lastReceivedTime) - { - auto deltaT = hrc::now() - lastReceivedTime; - uint deltams = std::chrono::duration_cast < std::chrono::milliseconds > (deltaT).count(); - VLOG(4) << "Heartbeat with delta T = " << deltams << "ms"; - lastReceivedTime = hrc::now(); - } - - void sendHeartbeat(hrc::time_point& lastSendTime, Socket& socket, uint msFrequency) - { - auto currentTime = hrc::now(); - auto timeSinceLastHb = std::chrono::duration_cast(currentTime - lastSendTime); - if (timeSinceLastHb >= std::chrono::milliseconds(msFrequency)) - { - VLOG(4) << "Sending heartbeat..."; - socket.send({ HEARTBEAT }); - lastSendTime = hrc::now(); - } - } - - } // namespace comms -} // namespace stateline diff --git a/src/comms/clientheartbeat.hpp b/src/comms/clientheartbeat.hpp deleted file mode 100644 index e0819b6..0000000 --- a/src/comms/clientheartbeat.hpp +++ /dev/null @@ -1,58 +0,0 @@ -//! -//! Heartbeat routers that deal with client heartbeating -//! sending and receiving. -//! -//! \file comms/clientheartbeat.hpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include "messages.hpp" -#include "router.hpp" -#include "settings.hpp" -#include "socket.hpp" - -namespace stateline -{ - namespace comms - { - //! Heartbeat sockets talk on these addresses. - const std::string CLIENT_HB_SOCKET_ADDR = "inproc://clienthb"; - - //! Handles heartbeating on the client side. Client heartbeat assumes only - //! one connection (to the server), so sends and receives to one source only. - //! - class ClientHeartbeat - { - public: - //! Create a new client heartbeat thread. - //! - //! \param context The ZMQ context. - //! \param settings Heartbeat settings. - //! - ClientHeartbeat(zmq::context_t& context, const HeartbeatSettings& settings, bool& running); - - void start(); - - //! Cleanup resources used by the heartbeat thread. - //! - ~ClientHeartbeat(); - - private: - Socket socket_; - SocketRouter router_; - - uint msPollRate_; - - hrc::time_point lastSendTime_; - hrc::time_point lastReceivedTime_; - - bool& running_; - }; - } // namespace comms -} // namespace stateline - diff --git a/src/comms/datatypes.hpp b/src/comms/datatypes.hpp index 550377f..9286a43 100644 --- a/src/comms/datatypes.hpp +++ b/src/comms/datatypes.hpp @@ -1,4 +1,3 @@ -//! //! Contains comms data structures representing jobs and results. //! //! \file comms/datatypes.hpp @@ -10,17 +9,12 @@ #pragma once -#include -#include - #include "typedefs.hpp" -namespace stateline -{ - namespace comms - { - //! High resolution clock used for heartbeating - typedef std::chrono::high_resolution_clock hrc; +namespace stateline { namespace comms { + +using JobID = unsigned int; +using JobType = unsigned int; +using BatchID = unsigned int; - } // namespace comms -} // namespace stateline +} } diff --git a/src/comms/delegator.cpp b/src/comms/delegator.cpp index ab54c97..6147e14 100644 --- a/src/comms/delegator.cpp +++ b/src/comms/delegator.cpp @@ -9,271 +9,249 @@ #include "comms/delegator.hpp" #include "comms/datatypes.hpp" +#include "comms/endpoint.hpp" +#include "comms/protobuf.hpp" #include "comms/thread.hpp" -#include "common/string.hpp" #include + #include #include -namespace stateline +namespace stateline { namespace comms { + +namespace { + +struct RequesterEndpoint : Endpoint { - namespace comms + Socket& worker; + + RequesterEndpoint(Socket& requester, Socket& worker) + : Endpoint(requester) + , worker(worker) { - namespace - { - // TODO: should this be a float? - uint timeForJob(const Delegator::Worker& w, uint jobType) - { - auto& times = w.times.at(jobType); - uint totalTime = std::accumulate(std::begin(times), std::end(times), 0); - uint avg; - if (times.size() > 0) - avg = totalTime / times.size(); - else - avg = 5; // very short initial guess to encourage testing - return avg; - } + } - // TODO: could we compute these lazily? i.e. each time a new job is assigned, - // we update the expected finishing time? - uint usTillDone(const Delegator::Worker& w, uint jobType) - { - uint t = 0; - for (auto const& i : w.workInProgress) - t += timeForJob(w, i.second.type); - //now add the expected time for the new job - t += timeForJob(w, jobType); - return t; - } + void onBatchJob(const Message& m) + { + const auto batchJob = stringToProtobuf(m.data); - } + VLOG(2) << "Received batch with " << batch.job_types_size() << " jobs"; - Delegator::Delegator(zmq::context_t& context, const DelegatorSettings& settings, bool& running) - : context_(context), - requester_(context, ZMQ_ROUTER, "toRequester"), - heartbeat_(context, ZMQ_PAIR, "toHBRouter"), - network_(context, ZMQ_ROUTER, "toNetwork"), - router_("main", {&requester_, &heartbeat_, &network_}), - msPollRate_(settings.msPollRate), - hbSettings_(settings.heartbeat), - running_(running), - nextJobId_(0), - nJobTypes_(settings.nJobTypes) - { - // Initialise the local sockets - requester_.bind(DELEGATOR_SOCKET_ADDR); - heartbeat_.bind(SERVER_HB_SOCKET_ADDR); - network_.setFallback([&](const Message& m) { sendFailed(m); }); - std::string address = "tcp://*:" + std::to_string(settings.port); - network_.bind(address); - - LOG(INFO) << "Delegator listening on tcp://*:" + std::to_string(settings.port); - - // Specify the Delegator functionality - auto fDisconnect = [&](const Message& m) { disconnectWorker(m); }; - auto fNewWorker = [&](const Message &m) - { - //forwarding to HEARTBEAT - heartbeat_.send(m); - std::string worker = m.address.front(); - if (workers_.count(worker) == 0) - connectWorker(m); - }; - - auto fRcvRequest = [&](const Message &m) { receiveRequest(m); }; - auto fRcvResult = [&](const Message &m) { receiveResult(m); }; - auto fForwardToHB = [&](const Message& m) { heartbeat_.send(m); }; - auto fForwardToNetwork = [&](const Message& m) { network_.send(m); }; - auto fForwardToHBAndDisconnect = [&](const Message& m) - { fForwardToHB(m); fDisconnect(m); }; - - // Bind functionality to the router - const uint REQUESTER_SOCKET = 0, HB_SOCKET = 1, NETWORK_SOCKET = 2; - - router_.bind(REQUESTER_SOCKET, REQUEST, fRcvRequest); - router_.bind(NETWORK_SOCKET, HELLO, fNewWorker); - router_.bind(NETWORK_SOCKET, RESULT, fRcvResult); - router_.bind(NETWORK_SOCKET, HEARTBEAT, fForwardToHB); - router_.bind(NETWORK_SOCKET, GOODBYE, fForwardToHBAndDisconnect); - router_.bind(HB_SOCKET, HEARTBEAT, fForwardToNetwork); - router_.bind(HB_SOCKET, GOODBYE, fDisconnect); - - auto fOnPoll = [&] () {onPoll();}; - router_.bindOnPoll(fOnPoll); - } + // Add the batch as a pending request. + requests_.emplace(std::piecewise_construct, + std::forward_as_tuple(id), + std::forward_as_tuple(m.address, batchJob.data(), jobTypes.size())); - Delegator::~Delegator() + // Add each job in the batch to the queue. + for (std::size_t i = 0; i < batchJob.job_type_size(); i++) { + jobQueue_.emplace_back(nextJobId_++, batchJob.job_type(i)); } - void Delegator::start() - { - // Start the heartbeat thread and router - auto future = startInThread(running_, std::ref(context_), std::cref(hbSettings_)); - router_.poll(msPollRate_, running_); - future.wait(); - } + VLOG(2) << requests_.size() << " requests pending"; + } +}; - void Delegator::connectWorker(const Message& msg) - { - // Worker can now be 'connected' - // add jobtypes - std::pair jobTypeRange; - if (msg.data[0] == "") - { - jobTypeRange.first = 0; - jobTypeRange.second = nJobTypes_; - } - else - { - std::vector jobTypes; - splitStr(jobTypes, msg.data[0], ':'); - assert(jobTypes.size() == 2); - jobTypeRange.first = std::stoi(jobTypes[0]); - jobTypeRange.second = std::stoi(jobTypes[1]); - } +struct WorkerEndpoint : Endpoint +{ + Socket& requester; - Worker w {msg.address, jobTypeRange}; - for (uint i = jobTypeRange.first; i < jobTypeRange.second; i++) - w.times.emplace(i, CircularBuffer{10}); + WorkerEndpoint(Socket& worker, Socket& requester) + : Endpoint{worker} + , requester{requester} + { + } - std::string id = w.address.front(); - workers_.insert(std::make_pair(id, w)); - workerCount_++; - LOG(INFO)<< "Worker " << id << " connected, supporting jobtypes: " << msg.data[0]; - } + void onHello(const Message& m) + { + // add jobtypes + // TODO: job types - void Delegator::receiveRequest(const Message& msg) - { - std::string id = joinStr(msg.address, ":"); - std::set jobTypes; - splitStr(jobTypes, msg.data[0], ':'); + const auto hello = stringToProtobuf(m.data); - std::set jobTypesInt; - std::transform(jobTypes.begin(), jobTypes.end(), - std::inserter(jobTypesInt, jobTypesInt.begin()), - [](const std::string& x) { return std::stoi(x); }); + Worker w{m.address, jobTypeRange}; + for (auto i = jobTypeRange.first; i < jobTypeRange.second; ++i) + w.times.emplace(i, CircularBuffer{10}); + workers_.emplace(m.address, w); - VLOG(2) << "New request Received, with " << jobTypes.size() << " jobs."; - Request r {msg.address, jobTypesInt, msg.data[1], std::vector(jobTypes.size()), 0}; - requests_.insert(std::make_pair(id, r)); - uint idx=0; - for (auto const& t : jobTypesInt) - { - Job j = {t, std::to_string(nextJobId_), id, idx, {}}; //we're not starting with a job yet - jobQueue_.push_back(j); - nextJobId_++; - idx++; - } - VLOG(2) << requests_.size() << " requests currently pending."; - } + LOG(INFO)<< "Worker " << id << " connected, supporting jobtypes: "; // TODO + + hb.connect(m.address, std::chrono::seconds{10}); // TODO + } + + void onResult(const Message& m) + { + const auto it = workers_.find(m.address); + if (it == workers_.end()) + return; + + const auto result = protobufToString(m.data); + const Job& job = it->second.wip.at(result.id()); + + // timing information + const auto now = hrc::now(); + + // estimate time the worker spent on this job + const auto elapsedTime = now - job.startTime; - void Delegator::receiveResult(const Message& msg) + const auto usecs = std::chrono::duration_cast(elapsedTime).count(); + it->times.at(j.type).push_back(usecs); + it->lastResultTime = now; + + Request& req = requests_[j.batchID]; + req.results[j.jobTypeIndex] = result.data(); + req.numCompleted++; + + if (req.numCompleted == req.results.size()) { - std::string workerId = msg.address.front(); - if (!workers_.count(workerId)) - return; - - std::string jobID = msg.data[0]; - auto& worker = workers_.find(workerId)->second; - - Job& j = worker.workInProgress[jobID]; - // timing information - auto now = std::chrono::high_resolution_clock::now(); - // estimate time the worker spent on this job - auto elapsedTime = now - std::max(j.startTime, worker.lastResultTime); - - uint usecs = std::chrono::duration_cast(elapsedTime).count(); - worker.times.at(j.type).push_back(usecs); - worker.lastResultTime = now; - Request& r = requests_[j.requesterID]; - r.results[j.requesterIndex] = msg.data[1]; - r.nDone++; - - if (r.nDone == r.jobTypes.size()) - { - requester_.send({r.address, RESULT, r.results}); - requests_.erase(j.requesterID); - } - //remove job from work in progress store - worker.workInProgress.erase(jobID); + messages::BatchResult batchResult; + batchResult.set_id(req.id); + + for (const auto& r : req.results) + batchResult.add_data(r); + + requester_.send({req.address, BATCH_RESULT, protobufToString(batchResult)}); + requests_.erase(job.batchID); } - Delegator::Worker* Delegator::bestWorker(uint jobType, uint maxJobs) + // Remove job from work in progress store + worker.wip.erase(job.id); + } + + void onBye(const Message& m) { hb.disconnect(m.address); } + + void onAny(const Message& m) { hb.update(m.address); } +}; + + // TODO: should this be a float? + uint timeForJob(const Delegator::Worker& w, uint jobType) + { + auto& times = w.times.at(jobType); + uint totalTime = std::accumulate(std::begin(times), std::end(times), 0); + uint avg; + if (times.size() > 0) + avg = totalTime / times.size(); + else + avg = 5; // very short initial guess to encourage testing + return avg; + } + + // TODO: could we compute these lazily? i.e. each time a new job is assigned, + // we update the expected finishing time? + uint usTillDone(const Delegator::Worker& w, uint jobType) + { + uint t = 0; + for (auto const& i : w.workInProgress) + t += timeForJob(w, i.second.type); + //now add the expected time for the new job + t += timeForJob(w, jobType); + return t; + } + +} + +Delegator::Delegator(zmq::context_t& ctx, const DelegatorSettings& settings) + : requester_{ctx, ZMQ_ROUTER, "toRequester"} + , network_{ctx, ZMQ_ROUTER, "toNetwork"} + , msPollRate_{settings.msPollRate} + , hbSettings_{settings.heartbeat} + , nextJobId_{1} +{ + // Initialise the local sockets + requester_.bind(DELEGATOR_SOCKET_ADDR); + network_.connect(settings); + + network_.setFallback([&](const Message& m) { sendFailed(m); }); + + network_.bind("tcp://*:" + std::to_string(settings.port)); + + LOG(INFO) << "Delegator listening on tcp://*:" << settings.port; +} + +void Delegator::start(bool& running) +{ + while (running) + { + poll(std::tie(requester_, worker_), pollWait_); + + idle(); + hb_.idle(); + } +} + +Delegator::Worker* Delegator::bestWorker(uint jobType, uint maxJobs) +{ + // TODO: can we do this using an STL algorithm? + Delegator::Worker* best = nullptr; + uint bestTime = std::numeric_limits::max(); + for (auto& w : workers_) + { + if (jobType >= w.second.jobTypesRange.first && + jobType < w.second.jobTypesRange.second && + w.second.workInProgress.size() < maxJobs) { - // TODO: can we do this using an STL algorithm? - Delegator::Worker* best = nullptr; - uint bestTime = std::numeric_limits::max(); - for (auto& w : workers_) + uint t = usTillDone(w.second, jobType); + if (t < bestTime) { - if (jobType >= w.second.jobTypesRange.first && - jobType < w.second.jobTypesRange.second && - w.second.workInProgress.size() < maxJobs) - { - uint t = usTillDone(w.second, jobType); - if (t < bestTime) - { - best = &w.second; - bestTime = t; - } - } + best = &w.second; + bestTime = t; } - return best; } + } + return best; +} - void Delegator::onPoll() +void Delegator::idle() +{ + const uint maxJobs = 10; + auto i = std::begin(jobQueue_); + while (i != std::end(jobQueue_)) + { + auto worker = bestWorker(i->type, maxJobs); + if (!worker) { - const uint maxJobs = 10; - auto i = std::begin(jobQueue_); - while (i != std::end(jobQueue_)) - { - auto worker = bestWorker(i->type, maxJobs); - if (!worker) - { - ++i; - continue; - } - - std::string& data = requests_[i->requesterID].data; - network_.send({worker->address, JOB, {std::to_string(i->type), i->id, data}}); - i->startTime = std::chrono::high_resolution_clock::now(); - worker->workInProgress.insert(std::make_pair(i->id, *i)); - - // TODO: could we avoid removing this? What if we just mark it as being removed, - // and ignore it when we're polling? We can reap these 'zombie' jobs whenever - // they get removed from the front of the queue (assuming there's no job starvation). - // This way, we can keep using a queue instead of a list, so we can get - // better performance through cache locality. - jobQueue_.erase(i++); - } + ++i; + continue; } - void Delegator::disconnectWorker(const Message& goodbyeFromWorker) - { - //first address - std::string workerId = goodbyeFromWorker.address.front(); + std::string& data = requests_[i->requesterID].data; + network_.send({worker->address, JOB, {std::to_string(i->type), i->id, data}}); + i->startTime = std::chrono::high_resolution_clock::now(); + worker->workInProgress.insert(std::make_pair(i->id, *i)); + + // TODO: could we avoid removing this? What if we just mark it as being removed, + // and ignore it when we're polling? We can reap these 'zombie' jobs whenever + // they get removed from the front of the queue (assuming there's no job starvation). + // This way, we can keep using a queue instead of a list, so we can get + // better performance through cache locality. + jobQueue_.erase(i++); + } +} + +void Delegator::disconnectWorker(const std::string& addr) +{ + const auto it = workers_.find(m.address); + if (it == workers_.end()) + return; - if (!workers_.count(workerId)) - return; + LOG(INFO)<< "Worker " << addr << " disconnected: re-assigning their jobs"; - auto w = workers_.find(workerId)->second; - for (auto const& j : w.workInProgress) - jobQueue_.push_front(j.second); - workers_.erase(workerId); + // Push all the unfinished work back into the queue + for (const auto& kv : it->wip) + jobQueue_.push_front(kv.second); - workerCount_--; + workers_.erase(it); +} - LOG(INFO)<< "Worker " << workerId << " disconnected: re-assigning their jobs"; - } +void Delegator::sendFailed(const Message& m) +{ + LOG(INFO) << "Failed to send to " << m.address; + + disconnectWorker(m.address); +} + +} // namespace stateline - void Delegator::sendFailed(const Message& msgToWorker) - { - LOG(INFO)<< "Failed to send to " << msgToWorker.address.front(); - // messages to and from a worker both had that workers address at the - // front so disconnect will work in both cases - disconnectWorker(msgToWorker); - } - } // namespace stateline } // namespace comms diff --git a/src/comms/delegator.hpp b/src/comms/delegator.hpp index 0b13f3c..e601ea9 100644 --- a/src/comms/delegator.hpp +++ b/src/comms/delegator.hpp @@ -1,9 +1,9 @@ -//! //! The delegator is the intermediary between requesters and workers. It acts //! as the server to which workers connect, and requesters submit jobs. //! //! \file comms/delegator.hpp //! \author Lachlan McCalman +//! \author Darren Shen //! \date 2014 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA @@ -12,150 +12,100 @@ #pragma once #include "settings.hpp" -#include "messages.hpp" -#include "router.hpp" -#include "serverheartbeat.hpp" +#include "heartbeat.hpp" #include "common/circularbuffer.hpp" +#include #include #include #include #include -#include +namespace stateline { namespace comms { + +//! Address that the requesters connect their sockets to. +// const std::string DELEGATOR_SOCKET_ADDR = "inproc://delegator"; +const std::string DELEGATOR_SOCKET_ADDR = "ipc:///tmp/sl_delegator.socket"; -namespace stateline +//! Responsible for allocating jobs to workers. +//! +class Delegator { - namespace comms +public: + //! Construct a new delegator. + //! + //! \param ctx ZMQ context. + //! \param settings The configuration object. + //! + Delegator(zmq::context_t& ctx, const DelegatorSettings& settings); + + Delegator(const Delegator&) = delete; + Delegator& operator=(const Delegator&) = delete; + + void start(bool& running); + +private: + using std::chrono::high_resolution_clock = hrc; + + struct Request { - //! Address that the requesters connect their sockets to. - // const std::string DELEGATOR_SOCKET_ADDR = "inproc://delegator"; - const std::string DELEGATOR_SOCKET_ADDR = "ipc:///tmp/sl_delegator.socket"; - - //! Requester object that takes jobs and returns results. Communicates with - //! a delegator living in a (possibly) different thread. - //! - class Delegator + std::string address; + std::vector data; + std::vector results; + int nDone; + + Request(std::string address, std::vector data, std::size_t numJobTypes) + : address{std::move(address)} + , data{std::move(data)} + , results(numJobTypes) // Pre-allocate the vector + , nDone{0} { - public: - //! Create a new delegator. - //! - //! \param settings The configuration object. - //! - Delegator(zmq::context_t& context, const DelegatorSettings& settings, bool& running); - - // Delegators can't be copied. - Delegator(const Delegator &other) = delete; - - //! Safely stops all polling threads and cleans up. - //! - ~Delegator(); - - void start(); - - uint workerCount() const { return workerCount_.load(); } - - private: - struct Request - { - std::vector address; - std::set jobTypes; - std::string data; - std::vector results; - uint nDone; - }; - - struct Job - { - uint type; - std::string id; - std::string requesterID; - uint requesterIndex; - std::chrono::high_resolution_clock::time_point startTime; - }; - - struct Result - { - }; - - // TODO: public for now, some free functions in delegator.cpp need it - // Either make those member functions or add them as friends - public: - struct Worker - { - std::vector address; - std::pair jobTypesRange; - std::map workInProgress; - std::map> times; - std::chrono::high_resolution_clock::time_point lastResultTime; - - Worker(std::vector address, - std::pair jobTypesRange) - : address(std::move(address)), jobTypesRange(std::move(jobTypesRange)), - lastResultTime(std::chrono::high_resolution_clock::now()) - { - } - }; - - private: - void onPoll(); - - void receiveRequest(const Message& m); - - //! Connect a worker that has previously been sent a problem spec. - //! - //! \param m The JOBREQUEST message the connecting worker sent. - //! - void connectWorker(const Message& m); - - //! Send a job to a worker that has requested one. - //! - //! \param m the job request message. - //! - void sendJob(const Message& m); - - //! Disconnect a worker by removing it from the list of connected workers. - //! - //! \param m The GOODBYE message the connecting worker sent. - //! - void disconnectWorker(const Message& m); - - //! When a send fails, we disconnect the worker. - //! - //! \param m The message that failed to send. - //! - void sendFailed(const Message& m); - - //! Get a result from a worker, then swap it for a new job. - //! - //! \param m The JOBSWAP message. - //! - void receiveResult(const Message& m); - - // TODO: does this need to be a member function? - Worker* bestWorker(uint jobType, uint maxJobs); - - zmq::context_t& context_; - - // Sockets - Socket requester_; - Socket heartbeat_; - Socket network_; - SocketRouter router_; - - std::map workers_; - std::map requests_; - std::list jobQueue_; - - uint msPollRate_; - HeartbeatSettings hbSettings_; - - bool& running_; - uint nextJobId_; - - uint nJobTypes_; // Number of job types - std::atomic workerCount_; - }; - - } // namespace comms -}// namespace stateline + } + }; + + struct Job + { + JobType type; + JobID id; + BatchID batchID; + hrc::time_point startTime; + + Request(JobID id, JobType type, + }; + + struct Worker + { + std::string address; + std::pair jobTypesRange; //! + + //! + std::map workInProgress; + std::map> times; + hrc::time_point lastResultTime; + + Worker(std::vector address, + std::pair jobTypesRange) + : address{std::move(address)} + , jobTypesRange{std::move(jobTypesRange)} + , lastResultTime{hrc::now()} + { + } + }; + + void idle(); + + // TODO: does this need to be a member function? + Worker* bestWorker(uint jobType, uint maxJobs); + + // Sockets + Socket requester_; + Socket worker_; + + std::map workers_; + std::map requests_; + std::list jobQueue_; + + JobID nextJobId_; +}; + +} } diff --git a/src/comms/endpoint.hpp b/src/comms/endpoint.hpp new file mode 100644 index 0000000..a230a98 --- /dev/null +++ b/src/comms/endpoint.hpp @@ -0,0 +1,78 @@ +//! Provides a message handling layer above a socket. +//! +//! \file comms/endpoint.hpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include "comms/socket.hpp" + +namespace stateline { namespace comms { + +//! A wrapper around a socket that also has logic for handling different messages. +//! This class uses CRTP to statically dispatch callbacks based on message types. +//! To create a new endpoint, inherit from this class and implement any of the +//! callback handlers. +//! +template +class Endpoint +{ +public: + Endpoint(SocketType& socket) + : socket_{socket} + { + } + + void accept() + { + handle(socket_.recv()); + } + + zmq::socket_t& zmqSocket() + { + return socket_.zmqSocket(); + } + + void handle(const Message& m) + { + switch (m.subject) + { + case HEARTBEAT: + self().onHeartbeat(m); + break; + + case HELLO: + self().onHello(m); + break; + + default: + // TODO: unrecognised subject + break; + } + + onAny(m); + } + + void onAny(const Message&) { } + void onDefault(const Message&) { } + void onHeartbeat(const Message& m) { self().onDefault(m); } + void onHello(const Message& m) { self().onDefault(m); } + void onBye(const Message& m) { self().onDefault(m); } + void onJob(const Message& m) { self().onDefault(m); } + void onResult(const Message& m) { self().onDefault(m); } + void onBatchJob(const Message& m) { self().onDefault(m); } + void onBatchResult(const Message& m) { self().onDefault(m); } + +private: + Base& self() { return *static_cast(this); } + + SocketType& socket_; +}; + +} // namespace stateline + +}// namespace comms diff --git a/src/comms/handler.hpp b/src/comms/handler.hpp deleted file mode 100644 index d5e16b8..0000000 --- a/src/comms/handler.hpp +++ /dev/null @@ -1,34 +0,0 @@ -//! -//! Base class for handling socket events. -//! -//! \file comms/handler.hpp -//! \author Darren Shen -//! \date 2016 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include "messages.hpp" -#include "socket.hpp" - -namespace stateline -{ -namespace comms -{ - -template -class SocketHandler -{ -public: - void onHello() { } - void onRequest() { } - void onResult() { } - void onHeartbeat() { } - void onGoodbye() { } - void onDisconnect() { } - -}; - -} diff --git a/src/comms/heartbeat.cpp b/src/comms/heartbeat.cpp new file mode 100644 index 0000000..a008a78 --- /dev/null +++ b/src/comms/heartbeat.cpp @@ -0,0 +1,91 @@ +//! Implementation of heartbeat monitoring. +//! +//! \file comms/heartbeat.cpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "comms/heartbeat.hpp" + +#include + +namespace stateline { namespace comms { + +Heartbeat::Heartbeat() + : heartbeatCallback_{[](const auto&) { }} + , disconnectCallback_{[](const auto&) { }} +{ +} + +void Heartbeat::connect(const std::string& addr, std::chrono::seconds interval) +{ + auto ret = conns_.emplace(std::piecewise_construct, + std::forward_as_tuple(addr), + std::forward_as_tuple(interval)); + + sendHeartbeat(*ret.first); +} + +void Heartbeat::disconnect(const std::string& addr) +{ + VLOG(1) << addr << " disconnected"; + conns_.erase(addr); +} + +void Heartbeat::update(const std::string& addr) +{ + auto it = conns_.find(addr); + if (it == conns_.end()) + return; + + it->second.lastRecvTime = hrc::now(); +} + +std::chrono::milliseconds Heartbeat::idle() +{ + const auto now = hrc::now(); + + // Send any outstanding heartbeats. + hrc::time_point closest_timeout = hrc::time_point::max(); + for (auto& kv : conns_) + { + if (kv.second.lastSendTime + kv.second.interval <= now) + sendHeartbeat(kv); + + closest_timeout = std::min(closest_timeout, + kv.second.lastSendTime + kv.second.interval); + } + + // Call the disconnect callback for any timeouts and remove them from our records. + for (auto it = conns_.cbegin(); it != conns_.cend(); ) + { + // Disconnect if they missed 2 heartbeat intervals. + if (it->second.lastRecvTime + it->second.interval * 2 < now) + { + VLOG(1) << it->first << " timed out"; + disconnectCallback_(it->first); + it = conns_.erase(it); + } + else + { + ++it; + } + } + + // TODO: implement heartbeat negotation + return std::chrono::duration_cast( + hrc::now() - closest_timeout); +} + +void Heartbeat::sendHeartbeat(ConnMap::value_type& kv) +{ + VLOG(4) << "Sending HEARTBEAT to " << kv.first; + + heartbeatCallback_(kv.first); + kv.second.lastSendTime = hrc::now(); +} + +} } diff --git a/src/comms/heartbeat.hpp b/src/comms/heartbeat.hpp new file mode 100644 index 0000000..ad80a67 --- /dev/null +++ b/src/comms/heartbeat.hpp @@ -0,0 +1,71 @@ +//! Interface for heartbeat monitoring. +//! \file comms/heartbeat.hpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include "comms/messages.hpp" +#include "comms/settings.hpp" + +#include +#include + +namespace stateline { namespace comms { + +//! Manages the liveness of connections. This class has two roles. It keeps track +//! of heartbeats sent by connections and also triggers callbacks to send heartbeats. +//! +class Heartbeat +{ +public: + using HeartbeatCallback = std::function; + using DisconnectCallback = std::function; + + //! Construct a heartbeat manager. + //! + Heartbeat(); + + void connect(const std::string& addr, std::chrono::seconds interval); + + void update(const std::string& addr); + + void disconnect(const std::string& addr); + + //! Call this to handle timeouts and send heartbeats. + //! + std::chrono::milliseconds idle(); + + void bindHeartbeat(HeartbeatCallback callback) { heartbeatCallback_ = callback; } + + void bindDisconnect(DisconnectCallback callback) { disconnectCallback_ = callback; } + +private: + using hrc = std::chrono::high_resolution_clock; + + struct Connection + { + std::chrono::seconds interval; + hrc::time_point lastSendTime; + hrc::time_point lastRecvTime; + + Connection(std::chrono::seconds interval) + : interval{interval}, lastSendTime{hrc::now()} + { + } + }; + + using ConnMap = std::unordered_map; + + void sendHeartbeat(ConnMap::value_type& kv); + + ConnMap conns_; + HeartbeatCallback heartbeatCallback_; + DisconnectCallback disconnectCallback_; +}; + +} } diff --git a/src/comms/message.cpp b/src/comms/message.cpp new file mode 100644 index 0000000..d0413dd --- /dev/null +++ b/src/comms/message.cpp @@ -0,0 +1,17 @@ +#include "comms/message.hpp" + +namespace stateline +{ + +namespace comms +{ + +std::ostream& operator<<(std::ostream& os, const Message& m) +{ + os << "|" << m.address << "|<" << m.data.size() << " data frames>|"; + return os; +} + +} // namespace comms + +} // namespace stateline diff --git a/src/comms/message.hpp b/src/comms/message.hpp new file mode 100644 index 0000000..5046a1c --- /dev/null +++ b/src/comms/message.hpp @@ -0,0 +1,59 @@ +//! Contains a generic message structure. +//! +//! \file comms/socket.hpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include +#include +#include + +namespace stateline +{ + +namespace comms +{ + +//! Represents all the message types used in Stateline. +enum Subject : std::uint8_t // TODO: make this an enum class +{ + HEARTBEAT = 0, + HELLO = 1, + BYE = 2, + JOB = 3, + RESULT = 4, + BATCH_JOB = 5, + BATCH_RESULT = 6, + SIZE +}; + +//! Represents a network message. +struct Message +{ + // Put fields in this order for optimal struct packing. + std::string address; //! Identity of the source/destination socket. + std::string data; //! Payload data. + Subject subject; //! The type of message this is. + + //! Construct a new message. + //! \param address The address of the sender or receiver. + //! \param subject The type of message. + //! \param data The payload data. + Message(std::string address, Subject subject, std::string data) + : address{std::move(address)} + , data{std::move(data)} + , subject{subject} + { + } +}; + +std::ostream& operator<<(std::ostream& os, const Message& m); + +} + +} diff --git a/src/comms/messages.cpp b/src/comms/messages.cpp deleted file mode 100644 index 0a2af1a..0000000 --- a/src/comms/messages.cpp +++ /dev/null @@ -1,72 +0,0 @@ -//! -//! \file comms/messages.cpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "comms/messages.hpp" - -#include -#include - -namespace stateline -{ - namespace comms - { - //! Convert a subject into a string. - //! - //! \param s The subject to convert. - //! \return The string representation of the subject. - //! - std::string subjectString(Subject s) - { - switch (s) - { - case HELLO: return "HELLO"; - case HEARTBEAT: return "HEARTBEAT"; - case REQUEST: return "REQUEST"; - case JOB: return "JOB"; - case RESULT: return "RESULT"; - case GOODBYE: return "GOODBYE"; - default: return "UNKNOWN"; - } - } - - Message::Message(Address address, Subject subject, std::vector data) - : address(std::move(address)), subject(std::move(subject)), data(std::move(data)) - { - } - - Message::Message(Subject subject, std::vector data) - : subject(std::move(subject)), data(std::move(data)) - { - } - - bool Message::operator==(const Message& m) const - { - return address == m.address && subject == m.subject && data == m.data; - } - - std::string addressAsString(const Address& address) - { - // Concatenate the vector of addresses together with ':' as a delimiter - std::string result; - if (!address.empty()) { - result += address.back(); - std::for_each(address.rbegin() + 1, address.rend(), - [&](const std::string& addr) { result += ":" + addr; }); - } - return result; - } - - std::ostream& operator<<(std::ostream& os, const Message& m) - { - os << "|" << addressAsString(m.address) << "|" << subjectString(m.subject) << "|<" << m.data.size() << " data frames>|"; - return os; - } - - } // namespace comms -} // namespace stateline - diff --git a/src/comms/messages.hpp b/src/comms/messages.hpp deleted file mode 100644 index 9edfecb..0000000 --- a/src/comms/messages.hpp +++ /dev/null @@ -1,101 +0,0 @@ -//! -//! Contains the interface for representing network messages. -//! -//! \file comms/messages.hpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include -#include - -#include "datatypes.hpp" - -namespace stateline -{ - namespace comms - { - //! Represents the header of a message containing addresses. - using Address = std::vector; - - //! Defines the bytes actually sent in the subject frame messages. - //! Allows us to use a switch statement on the subject. - //! - // TODO: make into a enum class - enum Subject - { - HELLO = 0, - HEARTBEAT = 1, - REQUEST =2, - JOB = 3, - RESULT = 4, - GOODBYE = 5, - Size - }; - - //! Define valid messages to send between delegators and workers. - //! - struct Message - { - //! Constructor to build a message. - //! - //! \param address The address to send the message to. - //! \param subject The subject of the message (eg. HELLO, JOB etc). - //! \param data A vector of data to send in the message. Each element of - //! the vector is sent as a separate frame. - //! - Message(Address address, Subject subject, std::vector data = {}); - - //! Create a new message with no address. - //! - //! \param subject The subject of the message (eg. HELLO, JOB etc). - //! \param data A vector of data to send in the message. Each element of - //! the vector is sent as a separate frame. - //! - Message(Subject subject, std::vector data = {}); - - //! Equality comparator for testing purposes. - //! - //! \param m The message to compare with. - //! \return True if the message is equal to this message. - //! - bool operator==(const Message& m) const; - - //! Allows a message to be printed with std::cout. - //! - //! \param os the output stream. - //! \param m the message object. - //! - friend std::ostream& operator<<(std::ostream& os, const Message& m); - - //! The destination address of this message. - Address address; - - //! The subject of the message (e.g. HELLO). - Subject subject; - - //! The data that this message contains. - std::vector data; - }; - - //! Convert an address to a string. - //! - //! \param addr The address to convert. - //! \return The address as a single string. - //! - std::string addressAsString(const Address& address); - - //! Print a message for logging and debugging purposes. - //! - //! \param os The output stream. - //! \param m The message to print. - //! - std::ostream& operator<<(std::ostream& os, const Message& m); - - } // namespace comms -} // namespace stateline - diff --git a/src/comms/minion.cpp b/src/comms/minion.cpp deleted file mode 100644 index d0bbcc1..0000000 --- a/src/comms/minion.cpp +++ /dev/null @@ -1,57 +0,0 @@ -//! -//! \file comms/minion.cpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "comms/minion.hpp" -#include "common/string.hpp" - -#include - -namespace stateline -{ - namespace comms - { - Minion::Minion(zmq::context_t& context, const std::string socketAddr) - : socket_(context, ZMQ_DEALER, "toWorker") - { - socket_.connect(socketAddr.c_str()); - socket_.send({HELLO,{""}}); - } - - Minion::Minion(zmq::context_t& context, const std::pair& jobTypesRange, - const std::string socketAddr) - : socket_(context, ZMQ_DEALER, "toWorker") - { - socket_.connect(socketAddr.c_str()); - std::string jobstring = std::to_string(jobTypesRange.first) + ":" + - std::to_string(jobTypesRange.second); - socket_.send({HELLO,{jobstring}}); - } - - std::pair> Minion::nextJob() - { - VLOG(3) << "Minion waiting on next job"; - stateline::comms::Message r = socket_.receive(); - currentJob_ = r.data[1]; - - std::vector sampleVectorStr; - splitStr(sampleVectorStr, r.data[2], ':'); - - std::vector sample(sampleVectorStr.size()); - for (uint i = 0; i < sample.size(); i++) - sample[i] = std::stod(sampleVectorStr[i]); - - return std::make_pair(std::stoi(r.data[0]), sample); - } - - void Minion::submitResult(double result) - { - socket_.send({RESULT,{currentJob_, std::to_string(result)}}); - } - - } // namespace comms -} // namespace stateline diff --git a/src/comms/minion.hpp b/src/comms/minion.hpp deleted file mode 100644 index 8542800..0000000 --- a/src/comms/minion.hpp +++ /dev/null @@ -1,70 +0,0 @@ -//! -//! Object which actually performs the work requested then distributed by the -//! worker. There can be many minions in the same machine, but only one per -//! thread sending to a shared worker object. -//! -//! \file comms/minion.hpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -// Standard Library -#include -#include -// Prerequisites -#include -#include -// Project -#include "messages.hpp" -#include "worker.hpp" -#include "socket.hpp" - -namespace stateline -{ - namespace comms - { - //! Minion object that requests a job, computes the result, - //! then submits that result to the connected worker. - //! - class Minion - { - public: - //! Create a new a minion. - //! - //! \param w The parent worker object it communicates with. - //! \param jobTypes The job types that the minion will do - //! - Minion(zmq::context_t& context, const std::string socketAddr); - - //! Create a new a minion. - //! - //! \param w The parent worker object it communicates with. - //! \param jobTypes The job types that the minion will do - //! - Minion(zmq::context_t& context, const std::pair& jobTypeRange, - const std::string socketAddr); - - //! Gets a job from the worker. - //! - //! \return The job to do. - //! - std::pair> nextJob(); - - //! Submits a result to the worker. Call this function - //! after requesting a job with job(). - //! - //! \param result The computed result. - //! - void submitResult(double result); - - private: - Socket socket_; - std::string currentJob_; - }; - } // namespace comms -} // namespace stateline - diff --git a/src/comms/poll.hpp b/src/comms/poll.hpp new file mode 100644 index 0000000..d91525f --- /dev/null +++ b/src/comms/poll.hpp @@ -0,0 +1,77 @@ +//! Provides an interface for polling endpoints. +//! +//! \file comms/poll.hpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include "common/meta.hpp" + +#include +#include + +namespace stateline +{ + +namespace comms +{ + +namespace detail +{ + +template +zmq::pollitem_t getPollItem(Endpoint& endpoint) +{ + return {(void *)endpoint.zmqSocket(), 0, ZMQ_POLLIN, 0}; +} + +template +std::array toPollListImpl( + T&& t, meta::seq) +{ + return { { getPollItem(std::get(t))... } }; +} + +template +std::array toPollList( + const std::tuple& endpoints) +{ + return toPollListImpl(endpoints, meta::gen_seq()); +} + +} + +//! Poll a set of endpoints. +//! +template +std::size_t poll(std::tuple endpoints, + std::chrono::milliseconds wait) +{ + auto pollList = detail::toPollList(endpoints); + + // Block until a message arrives or timeout + zmq::poll(pollList.data(), pollList.size(), wait); + + // Figure out which socket it's from + std::size_t msgCount = 0; + for (std::size_t i = 0; i < pollList.size(); i++) + { + bool newMsg = pollList[i].revents & ZMQ_POLLIN; + if (newMsg) + { + meta::apply(endpoints, i, [](auto& e) { return e.accept(); }); + msgCount++; + } + } + + return msgCount; +} + +} // namespace stateline + +}// namespace comms diff --git a/src/comms/protobuf.hpp b/src/comms/protobuf.hpp new file mode 100644 index 0000000..d632c2c --- /dev/null +++ b/src/comms/protobuf.hpp @@ -0,0 +1,23 @@ +#pragma once + +#include + +namespace stateline { namespace comms { + +template +std::string protobufToString(const Protobuf& protobuf) +{ + std::string buf; + protobuf.SerializeToString(&buf); + return buf; +} + +template +Protobuf stringToProtobuf(const std::string& str) +{ + Protobuf protobuf; + protobuf.ParseFromString(str); + return protobuf; +} + +} } diff --git a/src/comms/requester.cpp b/src/comms/requester.cpp index 7d22e22..c673616 100644 --- a/src/comms/requester.cpp +++ b/src/comms/requester.cpp @@ -1,4 +1,3 @@ -//! //! \file comms/requester.cpp //! \author Lachlan McCalman //! \date 2014 @@ -7,52 +6,45 @@ //! #include "comms/requester.hpp" -#include "comms/delegator.hpp" -#include "common/string.hpp" -#include +#include "comms/protobuf.hpp" + #include -namespace stateline +namespace stateline { namespace comms { + +Requester::Requester(zmq::context_t& ctx, const std::string& addr) + : socket_{ctx, zmq::socket_type::dealer, "toDelegator"} { - namespace comms - { - Requester::Requester(zmq::context_t& context) - : socket_(context, ZMQ_DEALER ,"toDelegator") - { - socket_.setIdentifier(); - socket_.connect(DELEGATOR_SOCKET_ADDR.c_str()); - } - - void Requester::submit(uint id, const std::vector& jobTypes, const Eigen::VectorXd& data) - { - std::vector jobTypesStr; - std::transform(jobTypes.begin(), jobTypes.end(), - std::back_inserter(jobTypesStr), - [](uint x) { return std::to_string(x); }); - std::string jtstring = joinStr(jobTypesStr, ":"); - - std::vector dataVectorStr; - for (uint i = 0; i < data.size(); i++) { - dataVectorStr.push_back(std::to_string(data(i))); - } - - socket_.send({{ std::to_string(id)}, REQUEST, { jtstring, joinStr(dataVectorStr, ":") }}); - } - - std::pair> Requester::retrieve() - { - Message r = socket_.receive(); - uint id = std::stoul(r.address[0]); - - std::vector results; - for (const auto& x : r.data) - { - results.push_back(std::stod(x)); - } - - return std::make_pair(id, results); - } - - } // namespace comms -} // namespace stateline + socket_.setIdentity(); + socket_.connect(addr); +} + +void Requester::submit(BatchID id, const std::vector& jobTypes, + const std::vector& data) +{ + messages::BatchJob batchJob; + batchJob.set_id(id); + + for (const auto& jobType : jobTypes) + batchJob.add_job_type(jobType); + + for (auto x : data) + batchJob.add_data(x); + + socket_.send({"", BATCH_JOB, protobufToString(batchJob)}); +} + +std::pair> Requester::retrieve() +{ + const auto msg = socket_.recv(); + const auto batchResult = stringToProtobuf(msg.data); + + std::vector data; + for (int i = 0; i < batchResult.data_size(); i++) + data.push_back(batchResult.data(i)); + + return {batchResult.id(), std::move(data)}; +} + +} } diff --git a/src/comms/requester.hpp b/src/comms/requester.hpp index 4ab57e5..04b2fc2 100644 --- a/src/comms/requester.hpp +++ b/src/comms/requester.hpp @@ -1,10 +1,8 @@ -//! -//! Object which actually requests work and returns a result. Many of these can -//! live in the same executable, but only 1 per thread. They forward requests to -//! a shared (threadsafe) delegator object using zeromq inproc messaging +//! Interface for requesters. //! //! \file comms/requester.hpp //! \author Lachlan McCalman +//! \author Darren Shen //! \date 2014 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA @@ -12,53 +10,48 @@ #pragma once -#include -#include - #include "datatypes.hpp" -#include "messages.hpp" #include "socket.hpp" -namespace stateline -{ - namespace comms - { - //! Requester object that takes jobs and returns results. Communicates with - //! a delegator in a (possibly) different thread. - //! - class Requester - { - public: - - //! Create a new Requester. - //! - //! \param d A reference to the delegator object to communicate with - //! - Requester(zmq::context_t& context); +namespace stateline { namespace comms { - //! Submits a batch of jobs for computation and immediately returns. An id is - //! included to allow the batch to be identified later, because when batches - //! are retrieved they may not arrive in the order they were submitted. - //! - //! \param id The id of the batch - //! \param jobs The vector of jobs to compute - //! \return The results of the job computations - //! - void submit(uint id, const std::vector& jobTypes, const Eigen::VectorXd& data); - - //! Retrieves a batch of jobs that have previously been submitted for computation. - //! A pair is returned, with the id of the batch (from the submit call), - //! and the results. Note that batch may not be retrieved in the order - //! they were submitted. - //! - //! \returns A pair of the job id and the result - //! - std::pair> retrieve(); - - private: - // Communicates with another inproc socket in the delegator - Socket socket_; - }; - } // namespace comms -} // namespace stateline +//! Requester object that takes jobs and returns results. Communicates with +//! a delegator in a (possibly) different thread. +//! +class Requester +{ +public: + + //! Construct a new Requester. + //! + //! \param ctx ZMQ context used to communicate with the delegator. + //! \param addr Address of the delegator. + //! + Requester(zmq::context_t& ctx, const std::string& addr); + + //! Submits a batch of jobs for computation and immediately returns. An id is + //! included to allow the batch to be identified later, because when batches + //! are retrieved they may not arrive in the order they were submitted. + //! + //! \param id The id of the batch + //! \param jobTypes The vector of jobs to compute + //! \param data The data shared between all the jobs + //! + void submit(BatchID id, const std::vector& jobTypes, + const std::vector& data); + + //! Retrieves the results of a batch submitted previously. + //! This call blocks until the result of a batch is available. The order of the + //! results within the batch corresponds to the order of the submitted job types. + //! + //! \returns A pair of the job id and the result. + //! + std::pair> retrieve(); + +private: + // Communicates with another inproc socket in the delegator + Socket socket_; +}; + +} } diff --git a/src/comms/router.cpp b/src/comms/router.cpp deleted file mode 100644 index 223fecb..0000000 --- a/src/comms/router.cpp +++ /dev/null @@ -1,80 +0,0 @@ -//! -//! \file comms/router.cpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include -#include -#include "comms/router.hpp" -#include -#include - -typedef std::chrono::high_resolution_clock hrc; - -namespace stateline -{ - namespace comms - { - uint index(uint socketIndex, const Subject& s) - { - return (uint)Subject::Size * socketIndex + (uint)s; - } - - SocketRouter::SocketRouter(const std::string& name, const std::vector& sockets) - : name_(name), - sockets_(sockets), - callbacks_((uint)Subject::Size * sockets.size(), nullptr), // TODO: add default callback to throw exception - onPoll_([](){}) - { - for (auto s : sockets_) - { - s->setLinger(0); - pollList_.push_back({(void*)s->socket_, 0, ZMQ_POLLIN, 0}); - } - } - - SocketRouter::~SocketRouter() - { - } - - void SocketRouter::bind(uint socketIndex, const Subject& s, const Callback& f) - { - callbacks_[index(socketIndex, s)] = f; - } - - void SocketRouter::bindOnPoll(const std::function& f) - { - onPoll_ = f; - } - - // this is an int because -1 indicates no timeout - void SocketRouter::poll(int msWait, bool& running) - { - VLOG(1) << "Router " << name_ << "'s poll thread has started"; - while (running) - { - // block until a message arrives - zmq::poll(&(pollList_[0]), pollList_.size(), msWait); - - // figure out which socket it's from - for (uint i = 0; i < pollList_.size(); i++) - { - bool newMsg = pollList_[i].revents & ZMQ_POLLIN; - if (newMsg) - { - Message msg = sockets_[i]->receive(); - - VLOG(4) << "Router " << name_ << " received new message from socket " << sockets_[i]->name() << ": " << msg; - callbacks_[index(i, msg.subject)](msg); - } - } - onPoll_(); - } - LOG(INFO) << "Router " << name_ << "'s Poll thread has exited loop, must be shutting down"; - } - - } // namespace comms -} // namespace stateline diff --git a/src/comms/router.hpp b/src/comms/router.hpp index 23bd1f1..9fcda12 100644 --- a/src/comms/router.hpp +++ b/src/comms/router.hpp @@ -5,57 +5,116 @@ //! //! \file comms/router.hpp //! \author Lachlan McCalman -//! \date 2014 +//! \author Darren Shen +//! \date 2016 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA //! #pragma once -// Standard Library -#include +#include "common/meta.hpp" +#include "comms/message.hpp" +#include "comms/socket.hpp" + +#include +#include #include -// Project -#include "messages.hpp" -#include "socket.hpp" +#include namespace stateline { - namespace comms + +namespace comms +{ + +namespace detail +{ + +constexpr std::size_t index(std::size_t socketIndex, Subject s) +{ + return Subject::SIZE * socketIndex + static_cast(s); +} + +} + +//! The callback function upon receipt of a message +using Callback = std::function; + +//! Implements polling and configurable routing between an +//! arbitrary number of (pre-constructed) sockets. Functionality +//! is attached through a signal interface. +//! +template +class Router +{ +public: + //! Create a new socket router. + //! + Router(std::string name, const std::tuple& sockets) + : name_{std::move(name)} + , sockets_{sockets} + , onPoll_{[]() { }} + { + pollList_.reserve(sizeof...(Sockets)); + + meta::apply_all(sockets, [&list = pollList_](auto& s) + { + // Need to cast a socket_t into (void *) + list.push_back({(void *)s.zmqSocket(), 0, ZMQ_POLLIN, 0}); + }); + } + + template + void bind(const Callback& f) { + std::get(callbacks_) = f; + } - //! The callback function upon receipt of a message - typedef std::function Callback; + template + void bindOnPoll(const Callback& callback) { onPoll_ = callback; } - //! Implements polling and configurable routing between an - //! arbitrary number of (pre-constructed) sockets. Functionality - //! is attached through a signal interface. - //! - class SocketRouter + void pollStep(std::chrono::milliseconds wait) + { + // Block until a message arrives or timeout + zmq::poll(pollList_, wait); + + // Figure out which socket it's from + for (uint i = 0; i < pollList_.size(); i++) { - public: - //! Create a new socket router. - //! - SocketRouter(const std::string& name, const std::vector& sockets); + bool newMsg = pollList_[i].revents & ZMQ_POLLIN; + if (newMsg) + { + auto msg = meta::apply(sockets_, i, [](auto& m) { return m.recv(); }); + + VLOG(4) << "Router " << name_ << " received new message from socket " + << meta::apply(sockets_, i, [](auto& m) { return m.name(); }) << ": " << msg; + callbacks_[detail::index(i, msg.subject)](std::move(msg)); + } + } - //! Clean up resources used by the socket router. - //! - ~SocketRouter(); + onPoll_(); + } - void bind(uint socketIndex, const Subject& s, const Callback& f); + //! Start the router polling with a polling loop frequency + void poll(int msWait, bool& running) + { + while (running) + { + pollStep(std::chrono::milliseconds{msWait}); + } - void bindOnPoll(const std::function& f); + LOG(INFO) << "Router " << name_ << "'s Poll thread has exited loop, must be shutting down"; + } - //! Start the router polling with a polling loop frequency - void poll(int msPerPoll, bool& running); +private: + std::string name_; + std::tuple sockets_; + std::vector pollList_; + std::array callbacks_; + std::function onPoll_; +}; - private: - std::string name_; - std::vector sockets_; // TODO: do we need to store the sockets? - std::vector pollList_; - std::vector callbacks_; - std::function onPoll_; - }; +} // namespace stateline - } // namespace stateline }// namespace comms diff --git a/src/comms/serverheartbeat.hpp b/src/comms/serverheartbeat.hpp index cde9869..2b2939b 100644 --- a/src/comms/serverheartbeat.hpp +++ b/src/comms/serverheartbeat.hpp @@ -53,7 +53,7 @@ namespace stateline private: Socket socket_; - SocketRouter router_; + Router router_; uint msPollRate_; diff --git a/src/comms/settings.hpp b/src/comms/settings.hpp index ac77034..a281282 100644 --- a/src/comms/settings.hpp +++ b/src/comms/settings.hpp @@ -83,7 +83,7 @@ namespace stateline struct WorkerSettings { //! The rate at which the receive sockets are polled. - int msPollRate; + uint msPollRate; //! The address of the delegator to connect to. std::string networkAddress; diff --git a/src/comms/socket.cpp b/src/comms/socket.cpp index f8f61fc..bbee32e 100644 --- a/src/comms/socket.cpp +++ b/src/comms/socket.cpp @@ -1,8 +1,8 @@ -//! -//! Contains the implementation of the ZMQ socket wrapper. +//! Implementation of ZMQ socket wrappers. //! //! \file comms/socket.cpp //! \author Lachlan McCalman +//! \author Darren Shen //! \date 2014 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA @@ -15,192 +15,93 @@ #include #include +#include + namespace stateline { - namespace comms + +namespace comms +{ + +SocketBase::SocketBase(zmq::context_t& context, zmq::socket_type type, std::string name, int linger) + : socket_{context, type} + , name_{std::move(name)} + , onFailedSend_{[](const Message&) { throw std::runtime_error{"Failed to send message"}; }} +{ + socket_.setsockopt(ZMQ_LINGER, &linger, sizeof(linger)); +} + +void SocketBase::connect(const std::string& address) +{ + socket_.connect(address.c_str()); +} + +void SocketBase::bind(const std::string& address) +{ + try { - std::string receiveString(zmq::socket_t & socket) - { - zmq::message_t message; - std::string result = ""; - try - { - socket.recv(&message); - result = std::string(static_cast(message.data()), message.size()); - } - catch(const zmq::error_t& e) - { - VLOG(1) << "ZMQ receive has thrown with type " << e.what(); - throw; - } - return result; - } - - bool sendString(zmq::socket_t & socket, const std::string & string) - { - // Taken from zhelpers.hpp - zmq::message_t message(string.size()); - memcpy(message.data(), string.data(), string.size()); - - return socket.send(message); - } - - bool sendStringPart(zmq::socket_t & socket, const std::string & string) - { - // Taken from zhelpers.hpp - zmq::message_t message(string.size()); - memcpy(message.data(), string.data(), string.size()); - - return socket.send(message, ZMQ_SNDMORE); - } - - Socket::Socket(zmq::context_t& context, int type, const std::string& name, int linger) - : socket_(context, type), - name_(name), - onFailedSend_(nullptr) // TODO: default on failed send - { - setLinger(linger); - } - - void Socket::connect(const std::string& address) - { - socket_.connect(address.c_str()); - } - - void Socket::bind(const std::string& address) - { - try - { - socket_.bind(address.c_str()); - } - catch(...) - { - LOG(FATAL) << "Could not bind to " << address << ". Address already in use"; - } - } - - void Socket::send(const Message& m) - { - VLOG(5) << "Socket " << name_ << " sending " << m; - - try - { - // Remember we're using the vector as a stack, so iterate through the - // address in reverse. - for (auto it = m.address.rbegin(); it != m.address.rend(); ++it) - { - sendStringPart(socket_, *it); - } - - // Send delimiter - sendStringPart(socket_, ""); - - // Send subject, then data if there is any - auto subjectString = std::to_string(m.subject); - uint dataSize = m.data.size(); - if (dataSize > 0) - { - // The subject - sendStringPart(socket_, subjectString); - - // The data -- multipart - for (auto it = m.data.begin(); it != std::prev(m.data.end()); ++it) - { - sendStringPart(socket_, *it); - } - - // final or only part - sendString(socket_, m.data.back()); - } - else - { - // The subject - sendString(socket_, subjectString); - } - } - catch(...) - { - if (onFailedSend_) - { - onFailedSend_(m); - } - else - { - throw; - } - } - } - - Message Socket::receive() - { - std::vector address; - std::string frame = receiveString(socket_); - // Do we have an address? - while (frame.compare("") != 0) - { - address.push_back(frame); - frame = receiveString(socket_); - } - // address is a stack, so reverse it to get the right way around - std::reverse(address.begin(), address.end()); - - // We've just read the delimiter, so now get subject - auto subjectString = receiveString(socket_); - //the underlying representation is (explicitly) an int so fairly safe - Subject subject = (Subject)std::stoi(subjectString); - std::vector data; - while (true) - { - int isMore = 0; - size_t moreSize = sizeof(isMore); - socket_.getsockopt(ZMQ_RCVMORE, &isMore, &moreSize); - if (!isMore) - break; - data.push_back(receiveString(socket_)); - } - - Message message{std::move(address), subject, std::move(data)}; - VLOG(5) << "Socket " << name_ << " received " << message; - return message; - } - - // Options - void Socket::setFallback(const std::function& sendCallback) - { - onFailedSend_ = sendCallback; - } - - void Socket::setLinger(int l) - { - socket_.setsockopt(ZMQ_LINGER, &l, sizeof(int)); - } - - void Socket::setHWM(int n) - { - socket_.setsockopt(ZMQ_SNDHWM, &n, sizeof(int)); - } - - std::string Socket::name() const - { - return name_; - } - - void Socket::setIdentifier() - { - // Inspired by zhelpers.hpp - std::random_device rd; - std::mt19937 gen(rd()); - std::uniform_int_distribution<> dis(0, 0x10000); - std::stringstream ss; - ss << std::hex << std::uppercase << std::setw(4) << std::setfill('0') << dis(gen) << "-" << std::setw(4) << std::setfill('0') - << dis(gen); - setIdentifier(ss.str()); - } - - void Socket::setIdentifier(const std::string& id) - { - socket_.setsockopt(ZMQ_IDENTITY, id.c_str(), id.length()); - } - - } // namespace comms + socket_.bind(address.c_str()); + } + catch(...) + { + LOG(FATAL) << "Could not bind to " << address << ". Address already in use"; + } +} + +Socket::Socket(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger) + : SocketBase(ctx, type, std::move(name), linger) +{ +} + +void Socket::send(const Message& m) +{ + VLOG(5) << "Socket " << name() << " sending " << m; + + zmq::multipart_t msg; + if (!m.address.empty()) + msg.addstr(m.address); + msg.addtyp(m.subject); + msg.addstr(m.data); + + // Send the message + if (!msg.send(zmqSocket())) + onFailedSend(m); +} + +Message Socket::recv() +{ + // Receive a multipart message + zmq::multipart_t msg{zmqSocket()}; + assert(msg.size() == 2 || msg.size() == 3); + + // Get the address, subject and data in order + auto address = msg.size() == 2 ? "" : msg.popstr(); + auto subject = msg.poptyp(); + auto data = msg.popstr(); + + Message m{std::move(address), subject, std::move(data)}; + VLOG(5) << "Socket " << name() << " received " << m; + return m; +} + +void Socket::setIdentity() +{ + // Inspired by zhelpers.hpp + std::random_device rd; + std::mt19937 gen{rd()}; + std::uniform_int_distribution<> dis{0, 0x10000}; + std::stringstream ss; + ss << std::hex << std::uppercase << std::setw(4) << std::setfill('0') << dis(gen) << "-" << std::setw(4) << std::setfill('0') + << dis(gen); + + setIdentity(ss.str()); +} + +void Socket::setIdentity(const std::string& id) +{ + zmqSocket().setsockopt(ZMQ_IDENTITY, id.c_str(), id.length()); +} + +} // namespace comms + } // namespace stateline diff --git a/src/comms/socket.hpp b/src/comms/socket.hpp index a3afa4d..d83cd9e 100644 --- a/src/comms/socket.hpp +++ b/src/comms/socket.hpp @@ -1,40 +1,75 @@ +//! Wrapper around a ZMQ socket. +//! +//! \file comms/socket.hpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2014 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + #pragma once +#include "message.hpp" + #include -#include -#include "messages.hpp" +#include namespace stateline { - namespace comms - { - - // Wraps a zeromq socket with some extra goodies - class Socket - { - public: - Socket(zmq::context_t& context, int type, const std::string& name, int linger = -1); - Socket(const Socket&) = delete; - Socket& operator=(const Socket&) = delete; - - void connect(const std::string& address); - void bind(const std::string& address); - void send(const Message& m); - Message receive(); - void setFallback(const std::function& sendCallback); - void setLinger(int l); - void setHWM(int n); - void setIdentifier(); - void setIdentifier(const std::string& id); - std::string name() const; - - private: - zmq::socket_t socket_; - std::string name_; - std::function onFailedSend_; - - friend class SocketRouter; - }; - } -} + +namespace comms +{ + +enum { NO_LINGER = 0 }; + +//! Thin wrapper around a ZMQ socket. +class SocketBase +{ +public: + SocketBase(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger); + + SocketBase(const SocketBase&) = delete; + SocketBase& operator=(const SocketBase&) = delete; + + const std::string& name() const { return name_; } + zmq::socket_t& zmqSocket() { return socket_; } + + void connect(const std::string& address); + void bind(const std::string& address); + + template + void setFallback(const Callback& callback) { onFailedSend_ = callback; }; + void onFailedSend(const Message& m) { onFailedSend_(m); } + +private: + zmq::socket_t socket_; + std::string name_; + std::function onFailedSend_; +}; + +//! High-level wrapper around a ZMQ socket. This socket is used for internal messages. +struct Socket : public SocketBase +{ + Socket(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger = NO_LINGER); + + void send(const Message& m); + Message recv(); + + void setIdentity(); + void setIdentity(const std::string& id); +}; + +//! High-level wrapper around a ZMQ_STREAM socket. This socket is used for external messages. +struct RawSocket : public SocketBase +{ + RawSocket(zmq::context_t& ctx, std::string name, int linger = NO_LINGER); + + void send(const Message& m); + Message recv(); +}; + +} // namspace comms + +} // namespace stateline diff --git a/src/comms/supervisor.cpp b/src/comms/supervisor.cpp new file mode 100644 index 0000000..7ad341e --- /dev/null +++ b/src/comms/supervisor.cpp @@ -0,0 +1,116 @@ +//! Contains the implementation of the supervisor. +//! +//! \file comms/supervisor.cpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "comms/endpoint.hpp" +#include "comms/supervisor.hpp" +#include "comms/thread.hpp" + +#include + +namespace stateline { namespace comms { + +namespace { + +struct WorkerEndpoint : Endpoint +{ + Socket& delegator; + + WorkerEndpoint(RawSocket& worker, Socket& delegator) + : Endpoint{worker} + , delegator{delegator} + { + } + + void onHello(const Message& m) + { + messages::Hello hello; + hello.set_worker_id( + + delegator.send( + } + + void onResult(const Message& m) + { + } +}; + +} + +Worker::Worker(zmq::context_t& ctx, const WorkerSettings& settings, bool& running) + : minion_{ctx, "toMinion", NO_LINGER} + , network_{ctx, zmq::socket_type::dealer, "toNetwork", NO_LINGER} + , router_{"worker", std::tie(minion_, network_)} + , msPollRate_{settings.msPollRate} + , hbSettings_{settings.heartbeat} + , running_{running} + , minionWaiting_{true} +{ + // Initialise the local sockets + minion_.bind(settings.workerAddress); + network_.setIdentity(); + LOG(INFO) << "Worker connecting to " << settings.networkAddress; + network_.connect("tcp://" + settings.networkAddress); + + // Specify the Worker functionality + auto onJobFromNetwork = [&] (const Message& m) { + if (minionWaiting_) + { + minion_.send(m); + minionWaiting_ = false; + } + else + { + queue_.push(m); + } + }; + + auto onResultFromMinion = [&] (const Message & m) + { + network_.send(m); + if (queue_.size() > 0) + { + minion_.send(queue_.front()); + queue_.pop(); + } + else + { + minionWaiting_ = true; + } + }; + + auto forwardToHB = [&](const Message& m) { }; + auto forwardToNetwork = [&](const Message& m) { network_.send({{},m.subject, m.data}); }; + /*auto disconnect = [&](const Message&) + { + LOG(INFO)<< "Worker disconnecting from server"; + exit(EXIT_SUCCESS); + };*/ + + // Just the order we gave them to the router + const uint MINION_SOCKET = 0, NETWORK_SOCKET = 1; + + // Bind functionality to the router + router_.bind(onResultFromMinion); + router_.bind(forwardToNetwork); + router_.bind(onJobFromNetwork); + router_.bind(forwardToHB); + router_.bind(forwardToHB); + router_.bind(forwardToHB); + //router_.bindOnPoll(sendHeartbeat); +} + +void Worker::start() +{ + router_.poll(msPollRate_, running_); +} + +} + +} diff --git a/src/comms/supervisor.hpp b/src/comms/supervisor.hpp new file mode 100644 index 0000000..429c003 --- /dev/null +++ b/src/comms/supervisor.hpp @@ -0,0 +1,59 @@ +//! Contains the interface to the supervisor. +//! +//! \file comms/supervisor.hpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include +#include + +#include + +#include "settings.hpp" +#include "messages.hpp" +#include "datatypes.hpp" +#include "router.hpp" +#include "socket.hpp" + +namespace stateline { namespace comms { + +//! A supervisor provides an interface between the delegator and worker. +//! It manages a set of workers running on the same host and forwards work +//! from the delegator to those workers. +//! +class Supervisor +{ +public: + //! Construct a new worker that can handle multiple types of jobs. + //! + //! \param settings The configuration object. + //! + Supervisor(zmq::context_t& ctx, const WorkerSettings& settings); + + Supervisor(const Supervisor&) = delete; + Supervisor& operator=(const Supervisor&) = delete; + + //! Start the supervisor. + void start(bool& running); + +private: + RawSocket minion_; + Socket network_; + Router router_; + + uint msPollRate_; + HeartbeatSettings hbSettings_; + + std::queue queue_; + bool minionWaiting_; +}; + +} // namespace comms + +} // namespace stateline diff --git a/src/comms/worker.cpp b/src/comms/worker.cpp index e9ea8b0..54b7baa 100644 --- a/src/comms/worker.cpp +++ b/src/comms/worker.cpp @@ -16,89 +16,78 @@ namespace stateline { - namespace comms - { - - Worker::Worker(zmq::context_t& context, const WorkerSettings& settings, bool& running) - : context_(context), - minion_(context, ZMQ_DEALER, "toMinion"), - heartbeat_(context, ZMQ_PAIR, "toHBRouter"), - network_(context, ZMQ_DEALER, "toNetwork"), - router_("main", {&minion_, &heartbeat_, &network_}), - msPollRate_(settings.msPollRate), - hbSettings_(settings.heartbeat), - running_(running), - minionWaiting_(true) - { - // Initialise the local sockets - minion_.bind(settings.workerAddress); - heartbeat_.bind(CLIENT_HB_SOCKET_ADDR); - network_.setIdentifier(); - LOG(INFO) << "Worker connecting to " << settings.networkAddress; - network_.connect("tcp://" + settings.networkAddress); - - // Specify the Worker functionality - // - auto onJobFromNetwork = [&] (const Message& m) { - if (minionWaiting_) - { - minion_.send(m); - minionWaiting_ = false; - } - else - { - queue_.push(m); - } - }; - - auto onResultFromMinion = [&] (const Message & m) - { - network_.send(m); - if (queue_.size() > 0) - { - minion_.send(queue_.front()); - queue_.pop(); - } - else - { - minionWaiting_ = true; - } - }; - - auto forwardToHB = [&](const Message& m) { heartbeat_.send(m); }; - auto forwardToNetwork = [&](const Message& m) { network_.send({{},m.subject, m.data}); }; - auto disconnect = [&](const Message&) - { - LOG(INFO)<< "Worker disconnecting from server"; - exit(EXIT_SUCCESS); - }; +namespace comms +{ - // Just the order we gave them to the router - const uint MINION_SOCKET=0,HB_SOCKET=1,NETWORK_SOCKET=2; +Worker::Worker(zmq::context_t& ctx, const WorkerSettings& settings, bool& running) + : minion_{ctx, "toMinion", NO_LINGER} + , network_{ctx, zmq::socket_type::dealer, "toNetwork", NO_LINGER} + , router_{"worker", std::tie(minion_, network_)} + , msPollRate_{settings.msPollRate} + , hbSettings_{settings.heartbeat} + , running_{running} + , minionWaiting_{true} +{ + // Initialise the local sockets + minion_.bind(settings.workerAddress); + network_.setIdentity(); + LOG(INFO) << "Worker connecting to " << settings.networkAddress; + network_.connect("tcp://" + settings.networkAddress); - // Bind functionality to the router - router_.bind(MINION_SOCKET, RESULT, onResultFromMinion); - router_.bind(MINION_SOCKET, HELLO, forwardToNetwork); - router_.bind(HB_SOCKET, HEARTBEAT, forwardToNetwork); - router_.bind(HB_SOCKET, GOODBYE, disconnect); - router_.bind(NETWORK_SOCKET, JOB, onJobFromNetwork); - router_.bind(NETWORK_SOCKET, HEARTBEAT, forwardToHB); - router_.bind(NETWORK_SOCKET, HELLO, forwardToHB); - router_.bind(NETWORK_SOCKET, GOODBYE, forwardToHB); + // Specify the Worker functionality + auto onJobFromNetwork = [&] (const Message& m) { + if (minionWaiting_) + { + minion_.send(m); + minionWaiting_ = false; } - - Worker::~Worker() + else { + queue_.push(m); } + }; - void Worker::start() + auto onResultFromMinion = [&] (const Message & m) + { + network_.send(m); + if (queue_.size() > 0) { - // Start the heartbeat thread and router - auto future = startInThread(running_, std::ref(context_), std::cref(hbSettings_)); - router_.poll(msPollRate_, running_); - future.wait(); + minion_.send(queue_.front()); + queue_.pop(); } + else + { + minionWaiting_ = true; + } + }; + + auto forwardToHB = [&](const Message& m) { }; + auto forwardToNetwork = [&](const Message& m) { network_.send({{},m.subject, m.data}); }; + /*auto disconnect = [&](const Message&) + { + LOG(INFO)<< "Worker disconnecting from server"; + exit(EXIT_SUCCESS); + };*/ + + // Just the order we gave them to the router + const uint MINION_SOCKET = 0, NETWORK_SOCKET = 1; + + // Bind functionality to the router + router_.bind(onResultFromMinion); + router_.bind(forwardToNetwork); + router_.bind(onJobFromNetwork); + router_.bind(forwardToHB); + router_.bind(forwardToHB); + router_.bind(forwardToHB); + //router_.bindOnPoll(sendHeartbeat); +} + +void Worker::start() +{ + router_.poll(msPollRate_, running_); +} + +} - } } diff --git a/src/comms/worker.hpp b/src/comms/worker.hpp index 69aec56..e558bb4 100644 --- a/src/comms/worker.hpp +++ b/src/comms/worker.hpp @@ -21,71 +21,46 @@ #include "messages.hpp" #include "datatypes.hpp" #include "router.hpp" -#include "clientheartbeat.hpp" #include "socket.hpp" namespace stateline { - namespace comms - { - //! Worker object that takes jobs, forwards them to a minion - //! then receives results from the minion and send them back - //! to the delegator. - //! - class Worker - { - public: - //! Build a new worker that can handle multiple types of jobs. - //! - //! \param settings The configuration object. - //! - Worker(zmq::context_t& context, const WorkerSettings& settings, bool& running); - // Workers can't be copied. - Worker(const Worker &other) = delete; - - //! Destructor. Safely stops all polling threads and cleans up. - //! - ~Worker(); - - void start(); +namespace comms +{ - private: - zmq::context_t& context_; +//! Worker object that takes jobs, forwards them to a minion +//! then receives results from the minion and send them back +//! to the delegator. +//! +class Worker +{ +public: + //! Construct a new worker that can handle multiple types of jobs. + //! + //! \param settings The configuration object. + //! + Worker(zmq::context_t& ctx, const WorkerSettings& settings, bool& running); - Socket minion_; - Socket heartbeat_; - Socket network_; - SocketRouter router_; + // Workers can't be copied. + Worker(const Worker &) = delete; - uint msPollRate_; - HeartbeatSettings hbSettings_; + void start(); - bool& running_; +private: + RawSocket minion_; + Socket network_; + Router router_; - std::queue queue_; - bool minionWaiting_; - }; + uint msPollRate_; + HeartbeatSettings hbSettings_; - //! Forward a message to the delegator. - //! - //! \param m The message to forward. - //! \param router The socket router. - //! - void forwardToNetwork(const Message& m, SocketRouter& router); + bool& running_; - //! Forward a message to a minion. - //! - //! \param m The message to forward. - //! \param router The socket router. - //! - void forwardToMinion(const Message& m, SocketRouter& router); + std::queue queue_; + bool minionWaiting_; +}; - //! Disconnect from the server with a message. - //! - //! \param m The message to send to the server. - //! - void disconnectFromServer(const Message& m); +} // namespace comms - } // namespace comms } // namespace stateline diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt index d4ee176..732c0b2 100644 --- a/src/test/CMakeLists.txt +++ b/src/test/CMakeLists.txt @@ -5,25 +5,6 @@ # Authors: Hamish Ivey-Law # Date: 2016 - -if (NOT GTEST_ROOT) - SET(GTEST_ROOT "/usr/src/gtest") -endif() - -find_path(GTEST_SRC_DIR src/gtest-all.cc - HINTS $ENV{GTEST_ROOT} ${GTEST_ROOT}) -find_path(GTEST_INCLUDE_DIR gtest/gtest.h - HINTS $ENV{GTEST_ROOT}/include ${GTEST_ROOT}/include) -mark_as_advanced(GTEST_INCLUDE_DIR GTEST_SRC_DIR) - -FIND_PACKAGE_HANDLE_STANDARD_ARGS(GTest - "Couldn't find GTest; please check your GTEST_ROOT setting!" - GTEST_INCLUDE_DIR GTEST_SRC_DIR) - -INCLUDE_DIRECTORIES(SYSTEM "${GTEST_SRC_DIR}" - SYSTEM "${GTEST_INCLUDE_DIR}") -ADD_LIBRARY(gtest EXCLUDE_FROM_ALL ${GTEST_SRC_DIR}/src/gtest-all.cc) - SET(test_suite_name test-suite) ADD_CUSTOM_TARGET(check @@ -34,7 +15,14 @@ ADD_CUSTOM_TARGET(check ADD_EXECUTABLE(${test_suite_name} EXCLUDE_FROM_ALL main.cpp - delegator.cpp diagnostics.cpp message.cpp router.cpp socket.cpp - # chainarray.cpp db.cpp transport.cpp - ) -TARGET_LINK_LIBRARIES(${test_suite_name} statelineserver statelineclient gtest) + socket.cpp + endpoint.cpp + poll.cpp + router.cpp + heartbeat.cpp + requester.cpp + #delegator.cpp diagnostics.cpp router.cpp socket.cpp + # chainarray.cpp db.cpp +) + +TARGET_LINK_LIBRARIES(${test_suite_name} ${ZMQ_LIBRARY} statelineclient stateline-server) diff --git a/src/test/endpoint.cpp b/src/test/endpoint.cpp new file mode 100644 index 0000000..d4ca7a1 --- /dev/null +++ b/src/test/endpoint.cpp @@ -0,0 +1,69 @@ +//! Tests for endpoint. +//! +//! \file comms/tests/endpoint.cpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "catch/catch.hpp" + +#include "comms/endpoint.hpp" + +using namespace stateline::comms; + +namespace +{ + +struct TestEndpoint : Endpoint +{ + TestEndpoint(Socket& s) : Endpoint(s) { }; + + void onHeartbeat(const Message& m) + { + handledHeartbeat = true; + } + + bool handledHeartbeat{false}; +}; + +} + +TEST_CASE("Can create an endpoint with a socket", "[endpoint]") +{ + zmq::context_t ctx{1}; + + Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; + alpha.bind("inproc://alpha"); + + Socket beta{ctx, zmq::socket_type::pair, "beta"}; + beta.connect("inproc://alpha"); + + TestEndpoint endpoint{alpha}; + + Message msg{"", HEARTBEAT, ""}; + beta.send(msg); + + endpoint.accept(); + REQUIRE(endpoint.handledHeartbeat); +} + +TEST_CASE("Endpoints have default implementations", "[endpoint]") +{ + zmq::context_t ctx{1}; + + Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; + alpha.bind("inproc://alpha"); + + Socket beta{ctx, zmq::socket_type::pair, "beta"}; + beta.connect("inproc://alpha"); + + TestEndpoint endpoint{alpha}; + + Message msg{"", HELLO, ""}; + beta.send(msg); + + endpoint.accept(); + REQUIRE(!endpoint.handledHeartbeat); +} diff --git a/src/test/heartbeat.cpp b/src/test/heartbeat.cpp new file mode 100644 index 0000000..4983d0e --- /dev/null +++ b/src/test/heartbeat.cpp @@ -0,0 +1,28 @@ +//! Tests for heartbeat monitoring. +//! +//! \file comms/tests/poll.cpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "catch/catch.hpp" + +#include "comms/heartbeat.hpp" + +#include +#include + +using namespace stateline::comms; +using namespace std::chrono_literals; + +TEST_CASE("Heartbeat idle returns correct wait time", "[heartbeat]") +{ + Heartbeat hb; + hb.connect("foo", 1s); + std::this_thread::sleep_for(500ms); + hb.connect("bar", 1s); + + REQUIRE(hb.idle() < 500ms); +} diff --git a/src/test/main.cpp b/src/test/main.cpp index 46262b3..d8d8619 100644 --- a/src/test/main.cpp +++ b/src/test/main.cpp @@ -1,12 +1,13 @@ -#include "gtest/gtest.h" +#define CATCH_CONFIG_RUNNER +#include "catch/catch.hpp" + #include "app/logging.hpp" const int logLevel = -3; const bool stdErr = false; const std::string filename = "test.log"; -int main (int ac, char** av) { +int main(int argc, const char* argv[]) { stateline::initLogging(logLevel, stdErr, filename); - testing::InitGoogleTest(&ac, av); - return RUN_ALL_TESTS(); + return Catch::Session().run(argc, argv); } diff --git a/src/test/message.cpp b/src/test/message.cpp deleted file mode 100644 index 39d55e9..0000000 --- a/src/test/message.cpp +++ /dev/null @@ -1,80 +0,0 @@ -//! -//! \file comms/tests/message.cpp -//! \author Lachlan McCalman -//! \author Darren Shen -//! \date 2015 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include - -#include "comms/messages.hpp" - -using namespace stateline::comms; - -TEST(Message, canConstructMessageWithNoData) -{ - std::vector address = { "A", "B", "C" }; - Message m{address, HELLO}; - - ASSERT_EQ(3U, m.address.size()); - EXPECT_EQ("A", m.address[0]); - EXPECT_EQ("B", m.address[1]); - EXPECT_EQ("C", m.address[2]); - - EXPECT_EQ(HELLO, m.subject); - EXPECT_TRUE(m.data.empty()); -} - -TEST(Message, canConstructMessageWithData) -{ - std::vector address = { "A", "B", "C" }; - std::vector data = { "Data1", "Data2", "Data3" }; - Message m{address, HELLO, data}; - - ASSERT_EQ(3U, m.address.size()); - EXPECT_EQ("A", m.address[0]); - EXPECT_EQ("B", m.address[1]); - EXPECT_EQ("C", m.address[2]); - - EXPECT_EQ(HELLO, m.subject); - - ASSERT_EQ(3U, m.data.size()); - EXPECT_EQ("Data1", m.data[0]); - EXPECT_EQ("Data2", m.data[1]); - EXPECT_EQ("Data3", m.data[2]); -} - -TEST(Message, canConstructMessageWithNoAddress) -{ - std::vector data = { "Data1", "Data2", "Data3" }; - Message m{HELLO, data}; - - EXPECT_TRUE(m.address.empty()); - - EXPECT_EQ(HELLO, m.subject); - - ASSERT_EQ(3U, m.data.size()); - EXPECT_EQ("Data1", m.data[0]); - EXPECT_EQ("Data2", m.data[1]); - EXPECT_EQ("Data3", m.data[2]); -} - -TEST(Message, emptyAddressConvertsToStringCorrectly) -{ - std::vector address = {}; - EXPECT_EQ("", addressAsString(address)); -} - -TEST(Message, singleAddressConvertsToStringCorrectly) -{ - std::vector address = { "address" }; - EXPECT_EQ("address", addressAsString(address)); -} - -TEST(Message, addressContainingEmptyEntriesConvertsToStringCorrectly) -{ - std::vector address = { "", "A", "", "B1", "" }; - EXPECT_EQ(":B1::A:", addressAsString(address)); -} diff --git a/src/test/poll.cpp b/src/test/poll.cpp new file mode 100644 index 0000000..64d868b --- /dev/null +++ b/src/test/poll.cpp @@ -0,0 +1,99 @@ +//! Tests for polling. +//! +//! \file comms/tests/poll.cpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "catch/catch.hpp" + +#include "comms/endpoint.hpp" +#include "comms/poll.hpp" + +#include + +using namespace stateline::comms; +using namespace std::chrono_literals; + +namespace +{ + +struct TestEndpoint : Endpoint +{ + TestEndpoint(Socket& s) : Endpoint(s) { }; + + void onHeartbeat(const Message& m) + { + handledHeartbeat = true; + } + + bool handledHeartbeat{false}; +}; + +} + +TEST_CASE("Can poll with no endpoints", "[poll]") +{ + REQUIRE(poll(std::tie(), 100ms) == 0); +} + +TEST_CASE("Polling inactive endpoints does not call any callbacks", "[poll]") +{ + zmq::context_t ctx{1}; + + Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; + alpha.bind("inproc://alpha"); + + Socket beta{ctx, zmq::socket_type::pair, "beta"}; + beta.connect("inproc://alpha"); + + TestEndpoint alphaEndpoint{alpha}; + TestEndpoint betaEndpoint{beta}; + + REQUIRE(poll(std::tie(alphaEndpoint, betaEndpoint), 100ms) == 0); + REQUIRE(!alphaEndpoint.handledHeartbeat); + REQUIRE(!betaEndpoint.handledHeartbeat); +} + +TEST_CASE("Polling handles single callback", "[poll]") +{ + zmq::context_t ctx{1}; + + Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; + alpha.bind("inproc://alpha"); + + Socket beta{ctx, zmq::socket_type::pair, "beta"}; + beta.connect("inproc://alpha"); + + TestEndpoint alphaEndpoint{alpha}; + TestEndpoint betaEndpoint{beta}; + + alpha.send({"", HEARTBEAT, ""}); + + REQUIRE(poll(std::tie(alphaEndpoint, betaEndpoint), 100ms) == 1); + REQUIRE(!alphaEndpoint.handledHeartbeat); + REQUIRE(betaEndpoint.handledHeartbeat); +} + +TEST_CASE("Polling handles multiple callback", "[poll]") +{ + zmq::context_t ctx{1}; + + Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; + alpha.bind("inproc://alpha"); + + Socket beta{ctx, zmq::socket_type::pair, "beta"}; + beta.connect("inproc://alpha"); + + TestEndpoint alphaEndpoint{alpha}; + TestEndpoint betaEndpoint{beta}; + + alpha.send({"", HEARTBEAT, ""}); + beta.send({"", HEARTBEAT, ""}); + + REQUIRE(poll(std::tie(alphaEndpoint, betaEndpoint), 100ms) == 2); + REQUIRE(alphaEndpoint.handledHeartbeat); + REQUIRE(betaEndpoint.handledHeartbeat); +} diff --git a/src/test/requester.cpp b/src/test/requester.cpp new file mode 100644 index 0000000..bb25286 --- /dev/null +++ b/src/test/requester.cpp @@ -0,0 +1,78 @@ +//! Tests for polling. +//! +//! \file comms/tests/poll.cpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "catch/catch.hpp" + +#include "comms/requester.hpp" +#include "comms/protobuf.hpp" + +using namespace stateline::comms; + +constexpr const char* DELEGATOR_ADDR = "inproc://test"; + +TEST_CASE("Can connect to inproc delegator", "[requester]") +{ + zmq::context_t ctx{1}; + + Socket delegator{ctx, zmq::socket_type::router, "toRequester"}; + delegator.bind(DELEGATOR_ADDR); + + Requester req{ctx, DELEGATOR_ADDR}; +} + +TEST_CASE("Can submit to the delegator", "[requester]") +{ + zmq::context_t ctx{1}; + + Socket delegator{ctx, zmq::socket_type::router, "toRequester"}; + delegator.bind(DELEGATOR_ADDR); + + Requester req{ctx, DELEGATOR_ADDR}; + req.submit(42, {1, 2}, {3, 4}); + + const auto message = delegator.recv(); + REQUIRE(message.subject == BATCH_JOB); + + const auto batchJob = stringToProtobuf(message.data); + + REQUIRE(batchJob.id() == 42); + REQUIRE(batchJob.job_type_size() == 2); + REQUIRE(batchJob.job_type(0) == 1); + REQUIRE(batchJob.job_type(1) == 2); + REQUIRE(batchJob.data_size() == 2); + REQUIRE(batchJob.data(0) == 3); + REQUIRE(batchJob.data(1) == 4); +} + +TEST_CASE("Can retrieve from the delegator", "[requester]") +{ + zmq::context_t ctx{1}; + + Socket delegator{ctx, zmq::socket_type::router, "toRequester"}; + delegator.bind(DELEGATOR_ADDR); + + Requester req{ctx, DELEGATOR_ADDR}; + req.submit(42, {1, 2}, {3, 4}); // Submit so delegator can get its address + + const auto reqAddr = delegator.recv().address; + + messages::BatchResult batchResult; + batchResult.set_id(42); + batchResult.add_data(1); + batchResult.add_data(2); + + delegator.send({reqAddr, BATCH_RESULT, protobufToString(batchResult)}); + + const auto result = req.retrieve(); + + REQUIRE(result.first == 42); + REQUIRE(result.second.size() == 2); + REQUIRE(result.second[0] == 1); + REQUIRE(result.second[1] == 2); +} diff --git a/src/test/router.cpp b/src/test/router.cpp index e693d97..cc111eb 100644 --- a/src/test/router.cpp +++ b/src/test/router.cpp @@ -1,110 +1,76 @@ //! -//! \file comms/tests/router.cpp +//! \file comms/TEST_CASEs/router.cpp //! \author Lachlan McCalman //! \author Darren Shen -//! \date 2015 +//! \date 2016 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA //! -#include +#include "catch/catch.hpp" #include "comms/router.hpp" -using namespace stateline; +#include + using namespace stateline::comms; +using namespace std::chrono_literals; -TEST(Router, canPollRouterWithNoSockets) +TEST_CASE("Can poll a router with no sockets", "[router]") { - zmq::context_t context{1}; - bool running = true; - - auto routerFuture = std::async(std::launch::async, - [](bool& running) - { - SocketRouter router("testRouter", {}); - router.poll(100, running); - }, std::ref(running)); - - running = false; - routerFuture.wait(); + zmq::context_t ctx{1}; + + Router<> router{"test_router", std::tuple<>{}}; + router.pollStep(100ms); } -TEST(Router, routerPollCallsOnPollCallback) +TEST_CASE("Poll calls onPoll callback", "[router]") { - zmq::context_t context{1}; - bool running = true; - - Socket alpha{context, ZMQ_PAIR, "alpha"}; - alpha.bind("inproc://alpha"); - - Socket beta{context, ZMQ_PAIR, "beta"}; - beta.connect("inproc://alpha"); + zmq::context_t ctx{1}; - auto routerFuture = std::async(std::launch::async, - [](bool& running, Socket& alpha, Socket& beta) - { - SocketRouter router("testRouter", { &alpha, &beta }); - router.bindOnPoll([&]() { running = false; }); - router.poll(100, running); - }, std::ref(running), std::ref(alpha), std::ref(beta)); + bool called = false; + Router<> router("test_router", std::tuple<>{}); + router.bindOnPoll([&called]() { called = true; }); + router.pollStep(100ms); - routerFuture.wait(); - EXPECT_FALSE(running); + REQUIRE(called == true); } -TEST(Router, socketSendCallsBoundCallback) +TEST_CASE("Router calls bound callbacks", "[router]") { - zmq::context_t context{1}; - bool running = true; + zmq::context_t ctx{1}; - Socket alpha{context, ZMQ_PAIR, "alpha"}; + Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; alpha.bind("inproc://alpha"); - Socket beta{context, ZMQ_PAIR, "beta"}; + Socket beta{ctx, zmq::socket_type::pair, "beta"}; beta.connect("inproc://alpha"); - auto routerFuture = std::async(std::launch::async, - [](bool& running, Socket& alpha, Socket& beta) - { - bool alphaReceived = false; - bool betaReceived = false; - - SocketRouter router("testRouter", { &alpha, &beta }); - - router.bind(0, REQUEST, [&](const Message& m) - { - alphaReceived = true; - EXPECT_EQ(REQUEST, m.subject); - ASSERT_EQ(1U, m.data.size()); - EXPECT_EQ("request", m.data[0]); - }); - - router.bind(1, JOB, [&](const Message& m) - { - betaReceived = true; - EXPECT_EQ(JOB, m.subject); - ASSERT_EQ(1U, m.data.size()); - EXPECT_EQ("job", m.data[0]); - }); - - router.bindOnPoll([&]() - { - // Wait until both messages were received - if (alphaReceived && betaReceived) - running = false; - }); - - router.poll(100, running); - - ASSERT_TRUE(alphaReceived); - ASSERT_TRUE(betaReceived); - - }, std::ref(running), std::ref(alpha), std::ref(beta)); - - // Trigger the callbacks - beta.send({REQUEST, { "request" }}); - alpha.send({JOB, { "job" }}); - - routerFuture.wait(); + auto alphaReceived = false; + auto betaReceived = false; + + Router router{"test_router", std::tie(alpha, beta)}; + router.bind<0, RESULT>([&alphaReceived](const Message& m) + { + REQUIRE(m.subject == RESULT); + REQUIRE(m.data == "result"); + alphaReceived = true; + }); + + router.bind<1, JOB>([&betaReceived](const Message& m) + { + REQUIRE(m.subject == JOB); + REQUIRE(m.data == "job"); + betaReceived = true; + }); + + // Trigger the beta callback + alpha.send({"", JOB, "job"}); + router.pollStep(100ms); + REQUIRE(betaReceived); + + // Trigger the alpha callback + beta.send({"", RESULT, "result"}); + router.pollStep(100ms); + REQUIRE(alphaReceived); } diff --git a/src/test/socket.cpp b/src/test/socket.cpp index 889839f..693128f 100644 --- a/src/test/socket.cpp +++ b/src/test/socket.cpp @@ -1,84 +1,101 @@ +//! Tests for socket. //! //! \file comms/tests/socket.cpp //! \author Lachlan McCalman //! \author Darren Shen -//! \date 2015 +//! \date 2016 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA //! -#include +#include "catch/catch.hpp" #include "comms/socket.hpp" using namespace stateline::comms; -TEST(Socket, canCreatePairSocketsSharingContext) +TEST_CASE("Can create PAIR sockets", "[socket]") { - zmq::context_t context{1}; + zmq::context_t ctx{1}; - Socket alpha{context, ZMQ_PAIR, "alpha"}; - EXPECT_EQ("alpha", alpha.name()); + Socket alpha{ctx, zmq::socket_type::pair, "alpha", NO_LINGER}; + REQUIRE(alpha.name() == "alpha"); - Socket beta{context, ZMQ_PAIR, "beta"}; - EXPECT_EQ("beta", beta.name()); + Socket beta{ctx, zmq::socket_type::pair, "beta", NO_LINGER}; + REQUIRE(beta.name() == "beta"); } -TEST(Socket, canBindAndConnectPairSockets) +TEST_CASE("Can bind and connect PAIR-PAIR", "[socket]") { - zmq::context_t context{1}; + zmq::context_t ctx{1}; - Socket alpha{context, ZMQ_PAIR, "alpha"}; + Socket alpha{ctx, zmq::socket_type::pair, "alpha", NO_LINGER}; alpha.bind("inproc://alpha"); - Socket beta{context, ZMQ_PAIR, "beta"}; + Socket beta{ctx, zmq::socket_type::pair, "beta", NO_LINGER}; beta.connect("inproc://alpha"); } -TEST(Socket, canSendMessagesOverPairSockets) +TEST_CASE("Can send messages over PAIR-PAIR", "[socket]") { - zmq::context_t context{1}; + zmq::context_t ctx{1}; - Socket alpha{context, ZMQ_PAIR, "alpha"}; + Socket alpha{ctx, zmq::socket_type::pair, "alpha", NO_LINGER}; alpha.bind("inproc://alpha"); - Socket beta{context, ZMQ_PAIR, "beta"}; + Socket beta{ctx, zmq::socket_type::pair, "beta", NO_LINGER}; beta.connect("inproc://alpha"); - for (int i = 0; i < 10; i++) { - Message m{JOB, { std::to_string(i) }}; + for (int i = 0; i < 3; i++) { + Message m{"beta", JOB, std::to_string(i)}; alpha.send(m); - auto result = beta.receive(); - EXPECT_EQ(JOB, result.subject); - ASSERT_EQ(1U, result.data.size()); - EXPECT_EQ(std::to_string(i), result.data[0]); + auto result = beta.recv(); + REQUIRE(result.address == "beta"); + REQUIRE(result.subject == JOB); + REQUIRE(result.data == std::to_string(i)); } } -TEST(Socket, sendFailureThrowsExceptionByDefault) +TEST_CASE("Can bind and connect ROUTER-DEALER", "[socket]") { - zmq::context_t context{1}; - Socket alpha{context, ZMQ_REP, "alpha"}; - Message m{JOB, { "failure!" }}; - ASSERT_THROW(alpha.send(m), std::exception); + zmq::context_t ctx{1}; + + Socket router{ctx, zmq::socket_type::router, "router", NO_LINGER}; + router.bind("tcp://*:5000"); + + Socket dealer{ctx, zmq::socket_type::dealer, "dealer", NO_LINGER}; + dealer.connect("tcp://localhost:5000"); } -TEST(Socket, sendFailureCallsCustomFallback) +TEST_CASE("Can send messages over ROUTER-DEALER", "[socket]") { - zmq::context_t context{1}; - Socket alpha{context, ZMQ_REP, "alpha"}; - - bool calledFallback = false; - alpha.setFallback([&](const Message &m) - { - calledFallback = true; - EXPECT_EQ(JOB, m.subject); - ASSERT_EQ(1U, m.data.size()); - EXPECT_EQ("failure!", m.data[0]); - }); - - Message m{JOB, { "failure!" }}; - alpha.send(m); - ASSERT_TRUE(calledFallback); + zmq::context_t ctx{1}; + + Socket router{ctx, zmq::socket_type::router, "router", NO_LINGER}; + router.bind("tcp://*:5174"); + + Socket dealer{ctx, zmq::socket_type::dealer, "dealer", NO_LINGER}; + dealer.setIdentity("dealer"); + dealer.connect("tcp://localhost:5174"); + + for (int i = 0; i < 3; i++) { + // When ROUTER receives from DEALER, there should be the address of the DEALER. + Message m1{"", JOB, std::to_string(i)}; + dealer.send(m1); + + auto result1 = router.recv(); + REQUIRE(result1.address == "dealer"); + REQUIRE(result1.subject == JOB); + REQUIRE(result1.data == std::to_string(i)); + + // When DEALER receives from ROUTER, there should be no address. + Message m2{"dealer", JOB, std::to_string(i)}; + router.send(m2); + + auto result2 = dealer.recv(); + REQUIRE(result2.address == ""); + REQUIRE(result2.subject == JOB); + REQUIRE(result2.data == std::to_string(i)); + } } diff --git a/src/test/transport.cpp b/src/test/transport.cpp deleted file mode 100644 index 8b588ec..0000000 --- a/src/test/transport.cpp +++ /dev/null @@ -1,113 +0,0 @@ -//! -//! \file comms/testtransport.cpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "gtest/gtest.h" - -#include "comms/messages.hpp" -#include "comms/transport.hpp" -#include "comms/serial.hpp" - -#include - -using namespace stateline; -using namespace stateline::comms; - -class Transport: public testing::Test -{ - public: - zmq::context_t context_; - zmq::socket_t requestSocket_; - zmq::socket_t replySocket_; - - Transport() - : context_(1), requestSocket_(context_, ZMQ_REQ), replySocket_(context_, ZMQ_REP) - { - replySocket_.bind("tcp://*:5555"); - requestSocket_.connect("tcp://localhost:5555"); - } -}; - -TEST_F(Transport, sendReceiveString) -{ - std::string s = "I am a test string."; - - sendString(requestSocket_, s); - std::string r = receiveString(replySocket_); - EXPECT_EQ(r, s); -} - -TEST_F(Transport, sendReceiveMultipartString) -{ - std::string s1 = "first test string."; - std::string s2 = "second test string."; - std::string s3 = "third test string."; - - sendStringPart(requestSocket_, s1); - sendStringPart(requestSocket_, s2); - sendString(requestSocket_, s3); - std::string r1 = receiveString(replySocket_); - std::string r2 = receiveString(replySocket_); - std::string r3 = receiveString(replySocket_); - EXPECT_EQ(r1, s1); - EXPECT_EQ(r2, s2); - EXPECT_EQ(r3, s3); -} - -TEST_F(Transport, sendReceiveMessageAddrSubjData) -{ - Message m( - { "1234-1223", "0000-1111"}, stateline::comms::HELLO, - { "data1", "data2"}); - send(requestSocket_, m); - auto r = receive(replySocket_); - EXPECT_EQ(m,r); -} - -TEST_F(Transport, sendReceiveMessageSubjData) -{ - Message m(stateline::comms::HELLO, - { "data1", "data2"}); - send(requestSocket_, m); - auto r = receive(replySocket_); - EXPECT_EQ(m,r); -} - -TEST_F(Transport, sendReceiveMessageAddrSubj) -{ - Message m( - { "1234-1223", "0000-1111"}, stateline::comms::HELLO); - send(requestSocket_, m); - auto r = receive(replySocket_); - EXPECT_EQ(m,r); -} - -TEST_F(Transport, sendReceiveMessageSubj) -{ - Message m(stateline::comms::HELLO); - send(requestSocket_, m); - auto r = receive(replySocket_); - EXPECT_EQ(m,r); -} - -TEST_F(Transport, randomSocketIDs) -{ - auto i1 = randomSocketID(); - auto i2 = randomSocketID(); - EXPECT_NE(i1,i2); -} - -TEST_F(Transport, setSocketID) -{ - std::size_t size = 255; - char r[255]; - - std::string id = randomSocketID(); - setSocketID(id, requestSocket_); - requestSocket_.getsockopt(ZMQ_IDENTITY, (void*)r, &size); - EXPECT_EQ(std::string(r, size),id); -} From 4b9f7550a0cb5d0f1f4b891faf12e2a14daaa065 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Tue, 12 Jul 2016 14:42:52 +1000 Subject: [PATCH 02/28] Refactor worker into agent --- proto/messages.proto | 14 ++- src/comms/CMakeLists.txt | 2 +- src/comms/agent.cpp | 145 ++++++++++++++++++++++++++++ src/comms/agent.hpp | 51 ++++++++++ src/comms/binary.hpp | 87 +++++++++++++++++ src/comms/endpoint.hpp | 20 ++-- src/comms/heartbeat.cpp | 51 ++++++---- src/comms/heartbeat.hpp | 42 ++++++--- src/comms/message.cpp | 16 +++- src/comms/message.hpp | 11 ++- src/comms/poll.hpp | 77 --------------- src/comms/router.hpp | 102 +++++++++----------- src/comms/settings.hpp | 198 +++++++++++++++++++++------------------ src/comms/socket.cpp | 95 ++++++++++++------- src/comms/socket.hpp | 43 ++++----- src/comms/supervisor.cpp | 116 ----------------------- src/comms/supervisor.hpp | 59 ------------ src/comms/worker.cpp | 9 +- src/comms/worker.hpp | 5 +- src/test/CMakeLists.txt | 8 +- src/test/agent.cpp | 119 +++++++++++++++++++++++ src/test/binary.cpp | 41 ++++++++ src/test/endpoint.cpp | 47 +++------- src/test/heartbeat.cpp | 36 ++++++- src/test/poll.cpp | 99 -------------------- src/test/router.cpp | 67 +++++++------ src/test/socket.cpp | 157 +++++++++++++++++++++++-------- src/test/worker.cpp | 35 +++++++ 28 files changed, 1018 insertions(+), 734 deletions(-) create mode 100644 src/comms/agent.cpp create mode 100644 src/comms/agent.hpp create mode 100644 src/comms/binary.hpp delete mode 100644 src/comms/poll.hpp delete mode 100644 src/comms/supervisor.cpp delete mode 100644 src/comms/supervisor.hpp create mode 100644 src/test/agent.cpp create mode 100644 src/test/binary.cpp delete mode 100644 src/test/poll.cpp create mode 100644 src/test/worker.cpp diff --git a/proto/messages.proto b/proto/messages.proto index 7ba8281..c96cb54 100644 --- a/proto/messages.proto +++ b/proto/messages.proto @@ -4,10 +4,18 @@ message Heartbeat { // Empty message } +message Hello { + optional uint32 hb_timeout_secs = 1; +} + +message Welcome { + optional uint32 hb_timeout_secs = 1; +} + message Job { required uint32 id = 1; // Job ID optional uint32 job_type = 2; // Job type - repeated double data = 3; // Job data + repeated double data = 3 [packed=true]; // Job data } message Result { @@ -18,10 +26,10 @@ message Result { message BatchJob { required uint32 id = 1; // Batch ID repeated uint32 job_type = 2; // Job types this request uses - repeated double data = 3; // Job data + repeated double data = 3 [packed=true]; // Job data } message BatchResult { required uint32 id = 1; // Batch ID - repeated double data = 2; // Result data + repeated double data = 2 [packed=true]; // Result data } diff --git a/src/comms/CMakeLists.txt b/src/comms/CMakeLists.txt index 4f9a6f5..14b2040 100644 --- a/src/comms/CMakeLists.txt +++ b/src/comms/CMakeLists.txt @@ -7,4 +7,4 @@ ADD_LIBRARY(commoncomms OBJECT message.cpp socket.cpp heartbeat.cpp) ADD_LIBRARY(servercomms OBJECT requester.cpp) -ADD_LIBRARY(clientcomms OBJECT worker.cpp) +ADD_LIBRARY(clientcomms OBJECT agent.cpp) diff --git a/src/comms/agent.cpp b/src/comms/agent.cpp new file mode 100644 index 0000000..125ce87 --- /dev/null +++ b/src/comms/agent.cpp @@ -0,0 +1,145 @@ +//! Contains the implementation of the agent. +//! +//! \file comms/agent.cpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "comms/agent.hpp" + +#include "comms/endpoint.hpp" +#include "comms/protobuf.hpp" +#include "comms/router.hpp" + +#include + +#include + +namespace stateline { namespace comms { + +namespace { + +struct AgentState +{ + Socket& worker; + Socket& network; + std::queue queue; + bool workerWaiting; + + AgentState(Socket& worker, Socket& network) + : worker{worker} + , network{network} + , workerWaiting{false} + { + } +}; + +struct WorkerEndpoint : Endpoint +{ + AgentState& agent; + std::chrono::seconds timeout; + + WorkerEndpoint(AgentState& agent, std::chrono::seconds timeout) + : Endpoint{agent.worker} + , agent{agent} + , timeout{timeout} + { + } + + void onHello(const Message& m) + { + messages::Hello hello; + hello.set_hb_timeout_secs(timeout.count()); + agent.network.send({"", HELLO, protobufToString(hello)}); + } + + void onResult(const Message& m) + { + agent.network.send(m); // Forward result to delegator + + if (agent.queue.empty()) + { + agent.workerWaiting = true; + } + else + { + agent.worker.send(std::move(agent.queue.front())); + agent.queue.pop(); + } + } +}; + +struct NetworkEndpoint : Endpoint +{ + AgentState& agent; + + NetworkEndpoint(AgentState& agent) + : Endpoint{agent.network} + , agent{agent} + { + } + + void onWelcome(const Message& m) + { + const auto welcome = stringToProtobuf(m.data); + agent.network.startHeartbeats(m.address, std::chrono::seconds{welcome.hb_timeout_secs()}); + } + + void onJob(const Message& m) + { + if (agent.workerWaiting) + agent.worker.send(m); // Forward job to worker + else + agent.queue.push(m); + } + + void onBye(const Message& m) + { + // TODO stop! + } +}; + +} + +Agent::Agent(zmq::context_t& ctx, const AgentSettings& settings) + : settings_{settings} + , worker_{ctx, zmq::socket_type::rep, "toWorker"} + , network_{ctx, zmq::socket_type::dealer, "toNetwork"} +{ + // Initialise the local sockets + worker_.bind(settings.bindAddress); + network_.setIdentity(); + LOG(INFO) << "Worker connecting to " << settings.networkAddress; + network_.connect(settings.networkAddress); +} + +void Agent::poll() +{ + bool running = false; // Poll only once + start(running); +} + +void Agent::start(bool& running) +{ + AgentState agent{worker_, network_}; + WorkerEndpoint worker{agent, settings_.heartbeatTimeout}; + NetworkEndpoint network{agent}; + + Router router{"agent", std::tie(worker, network)}; + + const auto onIdle = [&network]() + { + // TODO: Ugly. + network.socket().heartbeats().idle(); + }; + + do + { + router.poll(onIdle); + } while (running); +} + +} } diff --git a/src/comms/agent.hpp b/src/comms/agent.hpp new file mode 100644 index 0000000..76bd067 --- /dev/null +++ b/src/comms/agent.hpp @@ -0,0 +1,51 @@ +//! Contains the interface to the agent. +//! +//! \file comms/agent.hpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include + +#include + +#include "settings.hpp" +#include "endpoint.hpp" + +namespace stateline { namespace comms { + +//! An agent provides an interface between the delegator and worker. +//! It manages a set of workers running on the same host and forwards work +//! from the delegator to those workers. +//! +class Agent +{ +public: + //! Construct a new agent that can handle multiple types of jobs. + //! + //! \param settings The configuration object. + //! + Agent(zmq::context_t& ctx, const AgentSettings& settings); + + Agent(const Agent&) = delete; + Agent& operator=(const Agent&) = delete; + + //! Poll the sockets once and handle any messages. + void poll(); + + //! Start the agent by polling indefinitely. + void start(bool& running); + +private: + AgentSettings settings_; + + Socket worker_; + Socket network_; +}; + +} } diff --git a/src/comms/binary.hpp b/src/comms/binary.hpp new file mode 100644 index 0000000..ef9624a --- /dev/null +++ b/src/comms/binary.hpp @@ -0,0 +1,87 @@ +//! Interface to the external binary protocol. +//! +//! \file src/comms/binary.hpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include +#include +#include + +namespace stateline { namespace comms { + +template +struct PackSize; + +template +struct PackSize +{ + static constexpr std::size_t value = sizeof(T) + PackSize::value; +}; + +template <> +struct PackSize<> { static constexpr std::size_t value = 0; }; + +namespace detail { + +char* packBufferImpl(char* buf) { return buf; } + +template +char* packBufferImpl(char* buf, T val, Args... args) +{ + memcpy(buf, reinterpret_cast(&val), sizeof(val)); + return packBufferImpl(buf + sizeof(val), args...); +} + +} // namespace detail + +template +std::string packBuffer(Args... args) +{ + // Preallocate the buffer + std::string buffer(PackSize::value, ' '); + detail::packBufferImpl(&buffer[0], args...); + return buffer; +} + +namespace detail { + +// TODO: there's gotta be a better way of doing this +template +typename std::enable_if< + sizeof...(Args) == 0, + std::pair, Iterator> +>::type unpackBufferImpl(Iterator first, Iterator, Done... done) +{ + return {std::forward_as_tuple(done...), first}; +} + +template +std::pair, Iterator> unpackBufferImpl(Iterator first, Iterator last, Done... done) +{ + assert(std::distance(last, first) >= sizeof(T)); + + T val = reinterpret_cast(*first); + return unpackBufferImpl(first + sizeof(T), last, done..., val); +} + +} + +template +std::pair, Iterator> unpackBuffer(Iterator first, Iterator last) +{ + return detail::unpackBufferImpl(first, last); +} + +template +std::tuple unpackBuffer(const std::string& str) +{ + return detail::unpackBufferImpl(str.begin(), str.end()).first; +} + +} } diff --git a/src/comms/endpoint.hpp b/src/comms/endpoint.hpp index a230a98..320ddb8 100644 --- a/src/comms/endpoint.hpp +++ b/src/comms/endpoint.hpp @@ -10,6 +10,7 @@ #pragma once #include "comms/socket.hpp" +#include namespace stateline { namespace comms { @@ -18,25 +19,22 @@ namespace stateline { namespace comms { //! To create a new endpoint, inherit from this class and implement any of the //! callback handlers. //! -template +template class Endpoint { public: - Endpoint(SocketType& socket) + explicit Endpoint(Socket& socket) : socket_{socket} { } + Socket& socket() { return socket_; } + void accept() { handle(socket_.recv()); } - zmq::socket_t& zmqSocket() - { - return socket_.zmqSocket(); - } - void handle(const Message& m) { switch (m.subject) @@ -49,8 +47,13 @@ class Endpoint self().onHello(m); break; + case WELCOME: + self().onWelcome(m); + break; + default: // TODO: unrecognised subject + onDefault(m); break; } @@ -61,6 +64,7 @@ class Endpoint void onDefault(const Message&) { } void onHeartbeat(const Message& m) { self().onDefault(m); } void onHello(const Message& m) { self().onDefault(m); } + void onWelcome(const Message& m) { self().onDefault(m); } void onBye(const Message& m) { self().onDefault(m); } void onJob(const Message& m) { self().onDefault(m); } void onResult(const Message& m) { self().onDefault(m); } @@ -70,7 +74,7 @@ class Endpoint private: Base& self() { return *static_cast(this); } - SocketType& socket_; + Socket& socket_; }; } // namespace stateline diff --git a/src/comms/heartbeat.cpp b/src/comms/heartbeat.cpp index a008a78..d2bb908 100644 --- a/src/comms/heartbeat.cpp +++ b/src/comms/heartbeat.cpp @@ -20,42 +20,63 @@ Heartbeat::Heartbeat() { } -void Heartbeat::connect(const std::string& addr, std::chrono::seconds interval) +void Heartbeat::connect(const std::string& addr, std::chrono::seconds timeout) { - auto ret = conns_.emplace(std::piecewise_construct, + // We send 2 heartbeats per timeout + const auto interval = std::chrono::duration_cast(timeout) / 2; + + conns_.emplace(std::piecewise_construct, std::forward_as_tuple(addr), std::forward_as_tuple(interval)); - - sendHeartbeat(*ret.first); } -void Heartbeat::disconnect(const std::string& addr) +void Heartbeat::disconnect(const std::string& addr, DisconnectReason reason) { - VLOG(1) << addr << " disconnected"; + switch (reason) + { + case DisconnectReason::USER_REQUESTED: + VLOG(1) << addr << " disconnected by request"; + break; + + case DisconnectReason::TIMEOUT: + VLOG(1) << addr << " disconnected by time out"; + break; + } + + disconnectCallback_(addr); conns_.erase(addr); } -void Heartbeat::update(const std::string& addr) +void Heartbeat::updateLastSendTime(const std::string& addr) +{ + auto it = conns_.find(addr); + if (it == conns_.end()) + return; + + it->second.lastSendTime = Clock::now(); +} + +void Heartbeat::updateLastRecvTime(const std::string& addr) { auto it = conns_.find(addr); if (it == conns_.end()) return; - it->second.lastRecvTime = hrc::now(); + it->second.lastRecvTime = Clock::now(); } -std::chrono::milliseconds Heartbeat::idle() +void Heartbeat::idle() { - const auto now = hrc::now(); + const auto now = Clock::now(); // Send any outstanding heartbeats. - hrc::time_point closest_timeout = hrc::time_point::max(); + nextTimeout_ = Clock::time_point::max(); for (auto& kv : conns_) { if (kv.second.lastSendTime + kv.second.interval <= now) sendHeartbeat(kv); - closest_timeout = std::min(closest_timeout, + nextTimeout_ = std::min(nextTimeout_, kv.second.lastSendTime + kv.second.interval); } @@ -74,10 +95,6 @@ std::chrono::milliseconds Heartbeat::idle() ++it; } } - - // TODO: implement heartbeat negotation - return std::chrono::duration_cast( - hrc::now() - closest_timeout); } void Heartbeat::sendHeartbeat(ConnMap::value_type& kv) @@ -85,7 +102,7 @@ void Heartbeat::sendHeartbeat(ConnMap::value_type& kv) VLOG(4) << "Sending HEARTBEAT to " << kv.first; heartbeatCallback_(kv.first); - kv.second.lastSendTime = hrc::now(); + kv.second.lastSendTime = Clock::now(); } } } diff --git a/src/comms/heartbeat.hpp b/src/comms/heartbeat.hpp index ad80a67..1b97dbd 100644 --- a/src/comms/heartbeat.hpp +++ b/src/comms/heartbeat.hpp @@ -1,4 +1,5 @@ //! Interface for heartbeat monitoring. +//! //! \file comms/heartbeat.hpp //! \author Lachlan McCalman //! \author Darren Shen @@ -9,7 +10,7 @@ #pragma once -#include "comms/messages.hpp" +#include "comms/message.hpp" #include "comms/settings.hpp" #include @@ -17,12 +18,20 @@ namespace stateline { namespace comms { +enum class DisconnectReason +{ + USER_REQUESTED, // e.g. receiving a BYE message + TIMEOUT // heartbeat timeout +}; + //! Manages the liveness of connections. This class has two roles. It keeps track //! of heartbeats sent by connections and also triggers callbacks to send heartbeats. //! class Heartbeat { public: + using Clock = std::chrono::high_resolution_clock; + using HeartbeatCallback = std::function; using DisconnectCallback = std::function; @@ -30,31 +39,39 @@ class Heartbeat //! Heartbeat(); - void connect(const std::string& addr, std::chrono::seconds interval); + void connect(const std::string& addr, std::chrono::seconds timeout); - void update(const std::string& addr); + void disconnect(const std::string& addr, DisconnectReason reason = DisconnectReason::USER_REQUESTED); - void disconnect(const std::string& addr); + std::size_t numConnections() const { return conns_.size(); } + + Clock::time_point lastSendTime(const std::string& addr) const { return conns_.at(addr).lastSendTime; } + Clock::time_point lastRecvTime(const std::string& addr) const { return conns_.at(addr).lastRecvTime; } + + void updateLastSendTime(const std::string& addr); + void updateLastRecvTime(const std::string& addr); + + bool hasTimeout() const { return !conns_.empty(); } + Clock::time_point nextTimeout() const { return nextTimeout_; } //! Call this to handle timeouts and send heartbeats. //! - std::chrono::milliseconds idle(); + void idle(); void bindHeartbeat(HeartbeatCallback callback) { heartbeatCallback_ = callback; } void bindDisconnect(DisconnectCallback callback) { disconnectCallback_ = callback; } private: - using hrc = std::chrono::high_resolution_clock; - struct Connection { - std::chrono::seconds interval; - hrc::time_point lastSendTime; - hrc::time_point lastRecvTime; + std::chrono::milliseconds interval; + Clock::time_point lastSendTime; + Clock::time_point lastRecvTime; - Connection(std::chrono::seconds interval) - : interval{interval}, lastSendTime{hrc::now()} + Connection(std::chrono::milliseconds interval) + : interval{interval} + , lastRecvTime{Clock::now()} { } }; @@ -64,6 +81,7 @@ class Heartbeat void sendHeartbeat(ConnMap::value_type& kv); ConnMap conns_; + Clock::time_point nextTimeout_; // TODO: some sort of priority queue? HeartbeatCallback heartbeatCallback_; DisconnectCallback disconnectCallback_; }; diff --git a/src/comms/message.cpp b/src/comms/message.cpp index d0413dd..ccd2e15 100644 --- a/src/comms/message.cpp +++ b/src/comms/message.cpp @@ -1,14 +1,22 @@ #include "comms/message.hpp" -namespace stateline -{ +namespace stateline { namespace comms { -namespace comms +std::string subjectToString(Subject s) { + switch (s) + { + case HELLO: + return "HELLO"; + } + + return "UNKNOWN"; +} std::ostream& operator<<(std::ostream& os, const Message& m) { - os << "|" << m.address << "|<" << m.data.size() << " data frames>|"; + os << "|" << m.address << "|" << subjectToString(m.subject) << + "|<" << m.data.size() << " bytes>|"; return os; } diff --git a/src/comms/message.hpp b/src/comms/message.hpp index 5046a1c..11437fc 100644 --- a/src/comms/message.hpp +++ b/src/comms/message.hpp @@ -24,11 +24,12 @@ enum Subject : std::uint8_t // TODO: make this an enum class { HEARTBEAT = 0, HELLO = 1, - BYE = 2, - JOB = 3, - RESULT = 4, - BATCH_JOB = 5, - BATCH_RESULT = 6, + WELCOME = 2, + BYE = 3, + JOB = 4, + RESULT = 5, + BATCH_JOB = 6, + BATCH_RESULT = 7, SIZE }; diff --git a/src/comms/poll.hpp b/src/comms/poll.hpp deleted file mode 100644 index d91525f..0000000 --- a/src/comms/poll.hpp +++ /dev/null @@ -1,77 +0,0 @@ -//! Provides an interface for polling endpoints. -//! -//! \file comms/poll.hpp -//! \author Lachlan McCalman -//! \author Darren Shen -//! \date 2016 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include "common/meta.hpp" - -#include -#include - -namespace stateline -{ - -namespace comms -{ - -namespace detail -{ - -template -zmq::pollitem_t getPollItem(Endpoint& endpoint) -{ - return {(void *)endpoint.zmqSocket(), 0, ZMQ_POLLIN, 0}; -} - -template -std::array toPollListImpl( - T&& t, meta::seq) -{ - return { { getPollItem(std::get(t))... } }; -} - -template -std::array toPollList( - const std::tuple& endpoints) -{ - return toPollListImpl(endpoints, meta::gen_seq()); -} - -} - -//! Poll a set of endpoints. -//! -template -std::size_t poll(std::tuple endpoints, - std::chrono::milliseconds wait) -{ - auto pollList = detail::toPollList(endpoints); - - // Block until a message arrives or timeout - zmq::poll(pollList.data(), pollList.size(), wait); - - // Figure out which socket it's from - std::size_t msgCount = 0; - for (std::size_t i = 0; i < pollList.size(); i++) - { - bool newMsg = pollList[i].revents & ZMQ_POLLIN; - if (newMsg) - { - meta::apply(endpoints, i, [](auto& e) { return e.accept(); }); - msgCount++; - } - } - - return msgCount; -} - -} // namespace stateline - -}// namespace comms diff --git a/src/comms/router.hpp b/src/comms/router.hpp index 9fcda12..e15187c 100644 --- a/src/comms/router.hpp +++ b/src/comms/router.hpp @@ -22,99 +22,87 @@ #include #include -namespace stateline -{ +namespace stateline { namespace comms { -namespace comms -{ +namespace detail { -namespace detail +inline bool compSocketTimeouts(const SocketBase* a, const SocketBase* b) { - -constexpr std::size_t index(std::size_t socketIndex, Subject s) -{ - return Subject::SIZE * socketIndex + static_cast(s); + if (!a->heartbeats().hasTimeout()) return false; + if (!b->heartbeats().hasTimeout()) return true; + return a->heartbeats().nextTimeout() < b->heartbeats().nextTimeout(); } } -//! The callback function upon receipt of a message -using Callback = std::function; - -//! Implements polling and configurable routing between an -//! arbitrary number of (pre-constructed) sockets. Functionality -//! is attached through a signal interface. +//! Implements a reactor pattern dispatcher. Use this class to attach event handlers +//! to sockets. //! -template +template class Router { public: - //! Create a new socket router. + //! Create a new router. //! - Router(std::string name, const std::tuple& sockets) + Router(std::string name, const std::tuple& endpoints) : name_{std::move(name)} - , sockets_{sockets} - , onPoll_{[]() { }} + , endpoints_{endpoints} { - pollList_.reserve(sizeof...(Sockets)); + pollList_.reserve(sizeof...(Endpoints)); + sockets_.reserve(sizeof...(Endpoints)); - meta::apply_all(sockets, [&list = pollList_](auto& s) + meta::apply_all(endpoints, [&pollList = pollList_, &sockets = sockets_](auto& e) { // Need to cast a socket_t into (void *) - list.push_back({(void *)s.zmqSocket(), 0, ZMQ_POLLIN, 0}); + pollList.push_back({(void *)e.socket().zmqSocket(), 0, ZMQ_POLLIN, 0}); + sockets.push_back(static_cast(&e.socket())); }); } - template - void bind(const Callback& f) + template + void poll(const IdleCallback& callback) { - std::get(callbacks_) = f; - } + // Figure out how long we can wait for before any SocketBase times out + const auto it = std::min_element(sockets_.begin(), sockets_.end(), + detail::compSocketTimeouts); - template - void bindOnPoll(const Callback& callback) { onPoll_ = callback; } + if (it != sockets_.end()) + { + if ((*it)->heartbeats().hasTimeout()) + { + const auto wait = std::chrono::duration_cast( + (*it)->heartbeats().nextTimeout() - Heartbeat::Clock::now()); - void pollStep(std::chrono::milliseconds wait) - { - // Block until a message arrives or timeout - zmq::poll(pollList_, wait); + zmq::poll(pollList_, std::max(wait, std::chrono::milliseconds{0})); + } + else + { + // Poll indefinitely + zmq::poll(pollList_); + } + } - // Figure out which socket it's from - for (uint i = 0; i < pollList_.size(); i++) + // Handle each poll event + for (std::size_t i = 0; i < pollList_.size(); i++) { bool newMsg = pollList_[i].revents & ZMQ_POLLIN; if (newMsg) { - auto msg = meta::apply(sockets_, i, [](auto& m) { return m.recv(); }); + LOG(INFO) << "Router " << name_ << " received new message from endpoint " + << meta::apply(endpoints_, i, [](auto& m) { return m.socket().name(); }); - VLOG(4) << "Router " << name_ << " received new message from socket " - << meta::apply(sockets_, i, [](auto& m) { return m.name(); }) << ": " << msg; - callbacks_[detail::index(i, msg.subject)](std::move(msg)); + meta::apply(endpoints_, i, [](auto& e) { return e.accept(); }); } } - onPoll_(); - } - - //! Start the router polling with a polling loop frequency - void poll(int msWait, bool& running) - { - while (running) - { - pollStep(std::chrono::milliseconds{msWait}); - } - - LOG(INFO) << "Router " << name_ << "'s Poll thread has exited loop, must be shutting down"; + callback(); } private: std::string name_; - std::tuple sockets_; + std::tuple endpoints_; + std::vector sockets_; // TODO: make this into array std::vector pollList_; - std::array callbacks_; - std::function onPoll_; }; -} // namespace stateline - -}// namespace comms +} } diff --git a/src/comms/settings.hpp b/src/comms/settings.hpp index a281282..0d0a86a 100644 --- a/src/comms/settings.hpp +++ b/src/comms/settings.hpp @@ -11,101 +11,115 @@ #pragma once #include +#include -#include "../typedefs.hpp" +#include "typedefs.hpp" -namespace stateline +namespace stateline { namespace comms { + +//! Settings for controlling heartbeat threads. +//! +struct HeartbeatSettings { - namespace comms + //! The number of milliseconds between each heartbeat. + uint msRate; + + //! The rate at which the heartbeat sockets are polled. + int msPollRate; + + //! The heartbeat timeout in milliseconds. + uint msTimeout; + + static HeartbeatSettings WorkerDefault() + { + HeartbeatSettings settings; + settings.msRate = 1000; + settings.msPollRate = 500; + settings.msTimeout = 3000; + return settings; + } + + static HeartbeatSettings DelegatorDefault() + { + HeartbeatSettings settings; + settings.msRate = 1000; + settings.msPollRate = 500; + settings.msTimeout = 5000; + return settings; + } +}; + +//! Settings to control the behaviour of delegators. +//! +struct DelegatorSettings +{ + //! The rate at which the receive sockets are polled. + int msPollRate; + + //! The port number that the delegator listens on. + uint port; + + //! Settings for the heartbeat monitoring. + HeartbeatSettings heartbeat; + + //! number of job types. + uint nJobTypes; + + //! Default delegator settings + static DelegatorSettings Default(uint port) + { + DelegatorSettings settings; + settings.msPollRate = 10; + settings.port = port; + settings.heartbeat = HeartbeatSettings::DelegatorDefault(); + settings.nJobTypes = 1; + return settings; + } +}; + +//! Settings to control the behaviour of workers. +//! +struct WorkerSettings +{ + //! The address of the delegator to connect to. + std::string networkAddress; + + //! The address of this worker which the minion connects to. + std::string workerAddress; + + //! Settings for the heartbeat monitoring. + HeartbeatSettings heartbeat; + + //! Default delegator settings + WorkerSettings(std::string networkAddress, std::string workerAddress) + : networkAddress{std::move(networkAddress)} + , workerAddress{std::move(workerAddress)} + { + heartbeat = HeartbeatSettings::WorkerDefault(); + } +}; + +//! Settings to control the behaviour of agents. +//! +struct AgentSettings +{ + //! The address of this agent which the worker connects to. + std::string bindAddress; + + //! The address of the delegator to connect to. + std::string networkAddress; + + //! How long without heartbeats is considered times out. + std::chrono::seconds heartbeatTimeout; + + //! Construct default agent settings. + //! + AgentSettings(std::string bindAddress, std::string networkAddress) + : bindAddress{std::move(bindAddress)} + , networkAddress{std::move(networkAddress)} { - //! Settings for controlling heartbeat threads. - //! - struct HeartbeatSettings - { - //! The number of milliseconds between each heartbeat. - uint msRate; - - //! The rate at which the heartbeat sockets are polled. - int msPollRate; - - //! The heartbeat timeout in milliseconds. - uint msTimeout; - - static HeartbeatSettings WorkerDefault() - { - HeartbeatSettings settings; - settings.msRate = 1000; - settings.msPollRate = 500; - settings.msTimeout = 3000; - return settings; - } - - static HeartbeatSettings DelegatorDefault() - { - HeartbeatSettings settings; - settings.msRate = 1000; - settings.msPollRate = 500; - settings.msTimeout = 5000; - return settings; - } - }; - - //! Settings to control the behaviour of delegators. - //! - struct DelegatorSettings - { - //! The rate at which the receive sockets are polled. - int msPollRate; - - //! The port number that the delegator listens on. - uint port; - - //! Settings for the heartbeat monitoring. - HeartbeatSettings heartbeat; - - //! number of job types. - uint nJobTypes; - - //! Default delegator settings - static DelegatorSettings Default(uint port) - { - DelegatorSettings settings; - settings.msPollRate = 10; - settings.port = port; - settings.heartbeat = HeartbeatSettings::DelegatorDefault(); - settings.nJobTypes = 1; - return settings; - } - }; - - //! Settings to control the behaviour of workers. - //! - struct WorkerSettings - { - //! The rate at which the receive sockets are polled. - uint msPollRate; - - //! The address of the delegator to connect to. - std::string networkAddress; - - //! The address of this worker which the minion connects to. - std::string workerAddress; - - //! Settings for the heartbeat monitoring. - HeartbeatSettings heartbeat; - - //! Default delegator settings - static WorkerSettings Default(const std::string &networkAddress, - const std::string &workerAddress) - { - WorkerSettings settings; - settings.msPollRate = -1; - settings.networkAddress = networkAddress; - settings.workerAddress = workerAddress; - settings.heartbeat = HeartbeatSettings::WorkerDefault(); - return settings; - } - }; + heartbeatTimeout = std::chrono::seconds{15}; } -} +}; +} } diff --git a/src/comms/socket.cpp b/src/comms/socket.cpp index bbee32e..b3712ba 100644 --- a/src/comms/socket.cpp +++ b/src/comms/socket.cpp @@ -17,16 +17,11 @@ #include -namespace stateline -{ - -namespace comms -{ +namespace stateline { namespace comms { SocketBase::SocketBase(zmq::context_t& context, zmq::socket_type type, std::string name, int linger) : socket_{context, type} , name_{std::move(name)} - , onFailedSend_{[](const Message&) { throw std::runtime_error{"Failed to send message"}; }} { socket_.setsockopt(ZMQ_LINGER, &linger, sizeof(linger)); } @@ -48,43 +43,41 @@ void SocketBase::bind(const std::string& address) } } -Socket::Socket(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger) - : SocketBase(ctx, type, std::move(name), linger) -{ -} - -void Socket::send(const Message& m) +bool SocketBase::send(const std::string& address, const std::string& data) { - VLOG(5) << "Socket " << name() << " sending " << m; - zmq::multipart_t msg; - if (!m.address.empty()) - msg.addstr(m.address); - msg.addtyp(m.subject); - msg.addstr(m.data); + if (!address.empty()) + msg.addstr(address); + msg.addstr(data); // Send the message - if (!msg.send(zmqSocket())) - onFailedSend(m); + if (msg.send(socket_)) + { + hb_.updateLastSendTime(address); + return true; + } + + // TODO: disconnect heartbeat immediately + return false; } -Message Socket::recv() +std::pair SocketBase::recv() { // Receive a multipart message - zmq::multipart_t msg{zmqSocket()}; - assert(msg.size() == 2 || msg.size() == 3); + zmq::multipart_t msg{socket_}; + assert(msg.size() == 1 || msg.size() == 2); - // Get the address, subject and data in order - auto address = msg.size() == 2 ? "" : msg.popstr(); - auto subject = msg.poptyp(); + // Get the address and data + auto address = msg.size() == 1 ? "" : msg.popstr(); auto data = msg.popstr(); - Message m{std::move(address), subject, std::move(data)}; - VLOG(5) << "Socket " << name() << " received " << m; - return m; + hb_.updateLastRecvTime(address); + + return {std::move(address), std::move(data)}; } -void Socket::setIdentity() + +void SocketBase::setIdentity() { // Inspired by zhelpers.hpp std::random_device rd; @@ -97,11 +90,45 @@ void Socket::setIdentity() setIdentity(ss.str()); } -void Socket::setIdentity(const std::string& id) +void SocketBase::setIdentity(const std::string& id) { - zmqSocket().setsockopt(ZMQ_IDENTITY, id.c_str(), id.length()); + socket_.setsockopt(ZMQ_IDENTITY, id.c_str(), id.length()); } -} // namespace comms +void SocketBase::startHeartbeats(const std::string& address, std::chrono::seconds timeout) +{ + hb_.connect(address, timeout); +} + +Socket::Socket(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger) + : SocketBase(ctx, type, std::move(name), linger) +{ +} + +bool Socket::send(const Message& m) +{ + VLOG(5) << "Socket " << name() << " sending " << m; + + // Pack the subject and the data together + std::string buffer(sizeof(Subject) + m.data.size(), ' '); + memcpy(&buffer[0], reinterpret_cast(&m.subject), sizeof(Subject)); + memcpy(&buffer[0] + sizeof(Subject), m.data.data(), m.data.size()); + + return SocketBase::send(m.address, buffer); +} + +Message Socket::recv() +{ + auto msg = SocketBase::recv(); + assert(msg.second.size() >= sizeof(Subject)); + + // Unpack the subject and data + const auto subject = *reinterpret_cast(&msg.second[0]); + std::string data{msg.second.data() + sizeof(Subject), msg.second.data() + msg.second.size()}; + + Message m{msg.first, subject, std::move(data)}; + VLOG(5) << "Socket " << name() << " received " << m; + return m; +} -} // namespace stateline +} } diff --git a/src/comms/socket.hpp b/src/comms/socket.hpp index d83cd9e..3de3cc4 100644 --- a/src/comms/socket.hpp +++ b/src/comms/socket.hpp @@ -11,24 +11,21 @@ #pragma once #include "message.hpp" +#include "heartbeat.hpp" #include #include -namespace stateline -{ - -namespace comms -{ +namespace stateline { namespace comms { enum { NO_LINGER = 0 }; -//! Thin wrapper around a ZMQ socket. +//! Wrapper around a ZMQ socket. class SocketBase { public: - SocketBase(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger); + SocketBase(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger = NO_LINGER); SocketBase(const SocketBase&) = delete; SocketBase& operator=(const SocketBase&) = delete; @@ -36,17 +33,23 @@ class SocketBase const std::string& name() const { return name_; } zmq::socket_t& zmqSocket() { return socket_; } + bool send(const std::string& address, const std::string& data); + std::pair recv(); + void connect(const std::string& address); void bind(const std::string& address); - template - void setFallback(const Callback& callback) { onFailedSend_ = callback; }; - void onFailedSend(const Message& m) { onFailedSend_(m); } + void setIdentity(); + void setIdentity(const std::string& id); + + Heartbeat& heartbeats() { return hb_; } + const Heartbeat& heartbeats() const { return hb_; } + void startHeartbeats(const std::string& address, std::chrono::seconds timeout); private: zmq::socket_t socket_; std::string name_; - std::function onFailedSend_; + Heartbeat hb_; }; //! High-level wrapper around a ZMQ socket. This socket is used for internal messages. @@ -54,22 +57,8 @@ struct Socket : public SocketBase { Socket(zmq::context_t& ctx, zmq::socket_type type, std::string name, int linger = NO_LINGER); - void send(const Message& m); - Message recv(); - - void setIdentity(); - void setIdentity(const std::string& id); -}; - -//! High-level wrapper around a ZMQ_STREAM socket. This socket is used for external messages. -struct RawSocket : public SocketBase -{ - RawSocket(zmq::context_t& ctx, std::string name, int linger = NO_LINGER); - - void send(const Message& m); + bool send(const Message& m); Message recv(); }; -} // namspace comms - -} // namespace stateline +} } // namespace stateline diff --git a/src/comms/supervisor.cpp b/src/comms/supervisor.cpp deleted file mode 100644 index 7ad341e..0000000 --- a/src/comms/supervisor.cpp +++ /dev/null @@ -1,116 +0,0 @@ -//! Contains the implementation of the supervisor. -//! -//! \file comms/supervisor.cpp -//! \author Lachlan McCalman -//! \author Darren Shen -//! \date 2016 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "comms/endpoint.hpp" -#include "comms/supervisor.hpp" -#include "comms/thread.hpp" - -#include - -namespace stateline { namespace comms { - -namespace { - -struct WorkerEndpoint : Endpoint -{ - Socket& delegator; - - WorkerEndpoint(RawSocket& worker, Socket& delegator) - : Endpoint{worker} - , delegator{delegator} - { - } - - void onHello(const Message& m) - { - messages::Hello hello; - hello.set_worker_id( - - delegator.send( - } - - void onResult(const Message& m) - { - } -}; - -} - -Worker::Worker(zmq::context_t& ctx, const WorkerSettings& settings, bool& running) - : minion_{ctx, "toMinion", NO_LINGER} - , network_{ctx, zmq::socket_type::dealer, "toNetwork", NO_LINGER} - , router_{"worker", std::tie(minion_, network_)} - , msPollRate_{settings.msPollRate} - , hbSettings_{settings.heartbeat} - , running_{running} - , minionWaiting_{true} -{ - // Initialise the local sockets - minion_.bind(settings.workerAddress); - network_.setIdentity(); - LOG(INFO) << "Worker connecting to " << settings.networkAddress; - network_.connect("tcp://" + settings.networkAddress); - - // Specify the Worker functionality - auto onJobFromNetwork = [&] (const Message& m) { - if (minionWaiting_) - { - minion_.send(m); - minionWaiting_ = false; - } - else - { - queue_.push(m); - } - }; - - auto onResultFromMinion = [&] (const Message & m) - { - network_.send(m); - if (queue_.size() > 0) - { - minion_.send(queue_.front()); - queue_.pop(); - } - else - { - minionWaiting_ = true; - } - }; - - auto forwardToHB = [&](const Message& m) { }; - auto forwardToNetwork = [&](const Message& m) { network_.send({{},m.subject, m.data}); }; - /*auto disconnect = [&](const Message&) - { - LOG(INFO)<< "Worker disconnecting from server"; - exit(EXIT_SUCCESS); - };*/ - - // Just the order we gave them to the router - const uint MINION_SOCKET = 0, NETWORK_SOCKET = 1; - - // Bind functionality to the router - router_.bind(onResultFromMinion); - router_.bind(forwardToNetwork); - router_.bind(onJobFromNetwork); - router_.bind(forwardToHB); - router_.bind(forwardToHB); - router_.bind(forwardToHB); - //router_.bindOnPoll(sendHeartbeat); -} - -void Worker::start() -{ - router_.poll(msPollRate_, running_); -} - -} - -} diff --git a/src/comms/supervisor.hpp b/src/comms/supervisor.hpp deleted file mode 100644 index 429c003..0000000 --- a/src/comms/supervisor.hpp +++ /dev/null @@ -1,59 +0,0 @@ -//! Contains the interface to the supervisor. -//! -//! \file comms/supervisor.hpp -//! \author Lachlan McCalman -//! \author Darren Shen -//! \date 2016 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include -#include - -#include - -#include "settings.hpp" -#include "messages.hpp" -#include "datatypes.hpp" -#include "router.hpp" -#include "socket.hpp" - -namespace stateline { namespace comms { - -//! A supervisor provides an interface between the delegator and worker. -//! It manages a set of workers running on the same host and forwards work -//! from the delegator to those workers. -//! -class Supervisor -{ -public: - //! Construct a new worker that can handle multiple types of jobs. - //! - //! \param settings The configuration object. - //! - Supervisor(zmq::context_t& ctx, const WorkerSettings& settings); - - Supervisor(const Supervisor&) = delete; - Supervisor& operator=(const Supervisor&) = delete; - - //! Start the supervisor. - void start(bool& running); - -private: - RawSocket minion_; - Socket network_; - Router router_; - - uint msPollRate_; - HeartbeatSettings hbSettings_; - - std::queue queue_; - bool minionWaiting_; -}; - -} // namespace comms - -} // namespace stateline diff --git a/src/comms/worker.cpp b/src/comms/worker.cpp index 54b7baa..99187d4 100644 --- a/src/comms/worker.cpp +++ b/src/comms/worker.cpp @@ -14,17 +14,12 @@ #include #include -namespace stateline -{ - -namespace comms -{ +namespace stateline { namespace comms { Worker::Worker(zmq::context_t& ctx, const WorkerSettings& settings, bool& running) - : minion_{ctx, "toMinion", NO_LINGER} + : minion_{ctx, zmq::socket_type::dealer, "toMinion", NO_LINGER} , network_{ctx, zmq::socket_type::dealer, "toNetwork", NO_LINGER} , router_{"worker", std::tie(minion_, network_)} - , msPollRate_{settings.msPollRate} , hbSettings_{settings.heartbeat} , running_{running} , minionWaiting_{true} diff --git a/src/comms/worker.hpp b/src/comms/worker.hpp index e558bb4..bb299b7 100644 --- a/src/comms/worker.hpp +++ b/src/comms/worker.hpp @@ -18,7 +18,6 @@ #include #include "settings.hpp" -#include "messages.hpp" #include "datatypes.hpp" #include "router.hpp" #include "socket.hpp" @@ -48,9 +47,9 @@ class Worker void start(); private: - RawSocket minion_; + Socket minion_; Socket network_; - Router router_; + Router router_; uint msPollRate_; HeartbeatSettings hbSettings_; diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt index 732c0b2..1f04bfe 100644 --- a/src/test/CMakeLists.txt +++ b/src/test/CMakeLists.txt @@ -15,12 +15,14 @@ ADD_CUSTOM_TARGET(check ADD_EXECUTABLE(${test_suite_name} EXCLUDE_FROM_ALL main.cpp + binary.cpp socket.cpp + heartbeat.cpp endpoint.cpp - poll.cpp router.cpp - heartbeat.cpp - requester.cpp + agent.cpp + #poll.cpp + #requester.cpp #delegator.cpp diagnostics.cpp router.cpp socket.cpp # chainarray.cpp db.cpp ) diff --git a/src/test/agent.cpp b/src/test/agent.cpp new file mode 100644 index 0000000..f98ee85 --- /dev/null +++ b/src/test/agent.cpp @@ -0,0 +1,119 @@ +//! Tests for agent. +//! +//! \file comms/tests/agent.cpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "catch/catch.hpp" + +#include "comms/agent.hpp" +#include "comms/protobuf.hpp" + +#include + +using namespace stateline::comms; +using namespace std::chrono_literals; + +TEST_CASE("agent can connect to network and worker", "[agent]") +{ + zmq::context_t ctx{1}; + + AgentSettings settings{"ipc://test_agent", "ipc://test_network"}; + settings.heartbeatTimeout = 10s; + + Socket network{ctx, zmq::socket_type::router, "network"}; + network.bind(settings.networkAddress); + + Agent agent{ctx, settings}; + + Socket worker{ctx, zmq::socket_type::req, "worker"}; + worker.connect(settings.bindAddress); + + SECTION("forwards HELLO from worker to network") + { + REQUIRE(worker.send({ "", HELLO, "" }) == true); // TODO + agent.poll(); + + std::string agentAddress; + { + const auto msg = network.recv(); + agentAddress = msg.address; + REQUIRE(msg.subject == HELLO); + + const auto hello = stringToProtobuf(msg.data); + REQUIRE(hello.hb_timeout_secs() == 10); + } + + SECTION("starts heartbeats after WELCOME from network") + { + messages::Welcome welcome; + welcome.set_hb_timeout_secs(1); + + REQUIRE(network.send({ agentAddress, WELCOME, protobufToString(welcome) }) == true); + agent.poll(); + + // TODO: Should have received a heartbeat + { + //const auto msg = network.recv(); + //REQUIRE(msg.subject == HEARTBEAT); + } + + SECTION("forwards JOB from network to worker") + { + { + messages::Job job; + job.set_id(1); + job.set_job_type(2); + job.add_data(1); + + REQUIRE(network.send({ agentAddress, JOB, protobufToString(job) }) == true); + } + + agent.poll(); + + // TODO: should have received a JOB + + SECTION("forwards RESULT from worker to network") + { + //REQUIRE(worker.send({ "", RESULT, "" }) == true); + agent.poll(); + + // TODO: should have received a RESULT + } + + SECTION("queues up JOB if worker is busy") + { + { + messages::Job job; + job.set_id(2); + job.set_job_type(2); + job.add_data(1); + + REQUIRE(network.send({ agentAddress, JOB, protobufToString(job) }) == true); + } + + agent.poll(); + + // TODO should have queued + + SECTION("forwards RESULT from worker to network and sends queued JOB") + { + //REQUIRE(worker.send({ "", RESULT, "" }) == true); + agent.poll(); + + // TODO: should have received a RESULT + // TODO: should send the queued job + + SECTION("forwards RESULT from worker to network") + { + // TODO: should have received a RESULT + } + } + } + } + } + } +} diff --git a/src/test/binary.cpp b/src/test/binary.cpp new file mode 100644 index 0000000..2dba9f6 --- /dev/null +++ b/src/test/binary.cpp @@ -0,0 +1,41 @@ +//! Tests for binary packing and unpacking. +//! +//! \file comms/tests/binary.cpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "catch/catch.hpp" + +#include "comms/binary.hpp" + +using namespace stateline::comms; + +TEST_CASE("can pack empty tuple", "[binary]") +{ + REQUIRE(packBuffer() == ""); +} + +TEST_CASE("can unpack empty string", "[binary]") +{ + std::string str = ""; + const auto result = unpackBuffer(str.begin(), str.end()); + REQUIRE(std::tuple_size::value == 0); + REQUIRE(result.second == str.end()); +} + +TEST_CASE("can pack and unpack one item", "[binary]") +{ + const auto result = unpackBuffer(packBuffer(std::int32_t{42})); + REQUIRE(std::get<0>(result) == 42); +} + +TEST_CASE("can pack and unpack two items", "[binary]") +{ + const auto result = unpackBuffer(packBuffer(std::int32_t{42}, std::int8_t{1})); + REQUIRE(std::get<0>(result) == 42); + REQUIRE(std::get<1>(result) == 1); +} + diff --git a/src/test/endpoint.cpp b/src/test/endpoint.cpp index d4ca7a1..d02ea6f 100644 --- a/src/test/endpoint.cpp +++ b/src/test/endpoint.cpp @@ -13,43 +13,21 @@ using namespace stateline::comms; -namespace -{ +namespace { -struct TestEndpoint : Endpoint +// TODO: put this into a separate file shared with other tests +struct TestEndpoint : Endpoint { - TestEndpoint(Socket& s) : Endpoint(s) { }; + TestEndpoint(Socket& socket) : Endpoint{socket} { }; - void onHeartbeat(const Message& m) - { - handledHeartbeat = true; - } + void onHeartbeat(const Message& m) { handledHeartbeat = true; } bool handledHeartbeat{false}; }; } -TEST_CASE("Can create an endpoint with a socket", "[endpoint]") -{ - zmq::context_t ctx{1}; - - Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; - alpha.bind("inproc://alpha"); - - Socket beta{ctx, zmq::socket_type::pair, "beta"}; - beta.connect("inproc://alpha"); - - TestEndpoint endpoint{alpha}; - - Message msg{"", HEARTBEAT, ""}; - beta.send(msg); - - endpoint.accept(); - REQUIRE(endpoint.handledHeartbeat); -} - -TEST_CASE("Endpoints have default implementations", "[endpoint]") +TEST_CASE("endpoints handle messages correctly", "[endpoint]") { zmq::context_t ctx{1}; @@ -59,11 +37,14 @@ TEST_CASE("Endpoints have default implementations", "[endpoint]") Socket beta{ctx, zmq::socket_type::pair, "beta"}; beta.connect("inproc://alpha"); - TestEndpoint endpoint{alpha}; + TestEndpoint alphaEndpoint{alpha}; - Message msg{"", HELLO, ""}; - beta.send(msg); + SECTION("handles heartbeat message") + { + Message msg{"", HEARTBEAT, ""}; + beta.send(msg); - endpoint.accept(); - REQUIRE(!endpoint.handledHeartbeat); + alphaEndpoint.accept(); + REQUIRE(alphaEndpoint.handledHeartbeat); + } } diff --git a/src/test/heartbeat.cpp b/src/test/heartbeat.cpp index 4983d0e..f9b40e3 100644 --- a/src/test/heartbeat.cpp +++ b/src/test/heartbeat.cpp @@ -17,12 +17,42 @@ using namespace stateline::comms; using namespace std::chrono_literals; -TEST_CASE("Heartbeat idle returns correct wait time", "[heartbeat]") +TEST_CASE("heartbeat can connect and disconnect", "[heartbeat]") { Heartbeat hb; - hb.connect("foo", 1s); + + SECTION("defaults to no connections") + { + REQUIRE(hb.numConnections() == 0); + } + + SECTION("connect updates connections") + { + hb.connect("foo", 1s); + REQUIRE(hb.numConnections() == 1); + + SECTION("connecting same address updates connections") + { + hb.connect("foo", 2s); // TODO + REQUIRE(hb.numConnections() == 1); + } + + SECTION("disconnect updates connections") + { + hb.disconnect("foo"); + REQUIRE(hb.numConnections() == 0); + + SECTION("disconnecting same address does nothing") + { + hb.disconnect("foo"); + REQUIRE(hb.numConnections() == 0); + } + } + } + + /* std::this_thread::sleep_for(500ms); hb.connect("bar", 1s); - REQUIRE(hb.idle() < 500ms); + REQUIRE(hb.idle() < 500ms);*/ } diff --git a/src/test/poll.cpp b/src/test/poll.cpp deleted file mode 100644 index 64d868b..0000000 --- a/src/test/poll.cpp +++ /dev/null @@ -1,99 +0,0 @@ -//! Tests for polling. -//! -//! \file comms/tests/poll.cpp -//! \author Darren Shen -//! \date 2016 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "catch/catch.hpp" - -#include "comms/endpoint.hpp" -#include "comms/poll.hpp" - -#include - -using namespace stateline::comms; -using namespace std::chrono_literals; - -namespace -{ - -struct TestEndpoint : Endpoint -{ - TestEndpoint(Socket& s) : Endpoint(s) { }; - - void onHeartbeat(const Message& m) - { - handledHeartbeat = true; - } - - bool handledHeartbeat{false}; -}; - -} - -TEST_CASE("Can poll with no endpoints", "[poll]") -{ - REQUIRE(poll(std::tie(), 100ms) == 0); -} - -TEST_CASE("Polling inactive endpoints does not call any callbacks", "[poll]") -{ - zmq::context_t ctx{1}; - - Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; - alpha.bind("inproc://alpha"); - - Socket beta{ctx, zmq::socket_type::pair, "beta"}; - beta.connect("inproc://alpha"); - - TestEndpoint alphaEndpoint{alpha}; - TestEndpoint betaEndpoint{beta}; - - REQUIRE(poll(std::tie(alphaEndpoint, betaEndpoint), 100ms) == 0); - REQUIRE(!alphaEndpoint.handledHeartbeat); - REQUIRE(!betaEndpoint.handledHeartbeat); -} - -TEST_CASE("Polling handles single callback", "[poll]") -{ - zmq::context_t ctx{1}; - - Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; - alpha.bind("inproc://alpha"); - - Socket beta{ctx, zmq::socket_type::pair, "beta"}; - beta.connect("inproc://alpha"); - - TestEndpoint alphaEndpoint{alpha}; - TestEndpoint betaEndpoint{beta}; - - alpha.send({"", HEARTBEAT, ""}); - - REQUIRE(poll(std::tie(alphaEndpoint, betaEndpoint), 100ms) == 1); - REQUIRE(!alphaEndpoint.handledHeartbeat); - REQUIRE(betaEndpoint.handledHeartbeat); -} - -TEST_CASE("Polling handles multiple callback", "[poll]") -{ - zmq::context_t ctx{1}; - - Socket alpha{ctx, zmq::socket_type::pair, "alpha"}; - alpha.bind("inproc://alpha"); - - Socket beta{ctx, zmq::socket_type::pair, "beta"}; - beta.connect("inproc://alpha"); - - TestEndpoint alphaEndpoint{alpha}; - TestEndpoint betaEndpoint{beta}; - - alpha.send({"", HEARTBEAT, ""}); - beta.send({"", HEARTBEAT, ""}); - - REQUIRE(poll(std::tie(alphaEndpoint, betaEndpoint), 100ms) == 2); - REQUIRE(alphaEndpoint.handledHeartbeat); - REQUIRE(betaEndpoint.handledHeartbeat); -} diff --git a/src/test/router.cpp b/src/test/router.cpp index cc111eb..7785e1b 100644 --- a/src/test/router.cpp +++ b/src/test/router.cpp @@ -9,6 +9,7 @@ #include "catch/catch.hpp" +#include "comms/endpoint.hpp" #include "comms/router.hpp" #include @@ -16,27 +17,33 @@ using namespace stateline::comms; using namespace std::chrono_literals; -TEST_CASE("Can poll a router with no sockets", "[router]") +namespace { + +struct TestEndpoint : Endpoint { - zmq::context_t ctx{1}; + TestEndpoint(Socket& socket) + : Endpoint{socket} { }; + + void onHeartbeat(const Message& m) { handledHeartbeat = true; } + + bool handledHeartbeat{false}; +}; - Router<> router{"test_router", std::tuple<>{}}; - router.pollStep(100ms); } -TEST_CASE("Poll calls onPoll callback", "[router]") +TEST_CASE("can poll a router with no sockets", "[router]") { zmq::context_t ctx{1}; - bool called = false; - Router<> router("test_router", std::tuple<>{}); - router.bindOnPoll([&called]() { called = true; }); - router.pollStep(100ms); + Router<> router{"test_router", std::tie()}; - REQUIRE(called == true); + bool idleCalled = false; + router.poll([&idleCalled]() { idleCalled = true; }); + + REQUIRE(idleCalled == true); } -TEST_CASE("Router calls bound callbacks", "[router]") +TEST_CASE("router poll calls the correct callbacks", "[router]") { zmq::context_t ctx{1}; @@ -46,31 +53,21 @@ TEST_CASE("Router calls bound callbacks", "[router]") Socket beta{ctx, zmq::socket_type::pair, "beta"}; beta.connect("inproc://alpha"); - auto alphaReceived = false; - auto betaReceived = false; + TestEndpoint alphaEndpoint{alpha}; + TestEndpoint betaEndpoint{beta}; - Router router{"test_router", std::tie(alpha, beta)}; - router.bind<0, RESULT>([&alphaReceived](const Message& m) - { - REQUIRE(m.subject == RESULT); - REQUIRE(m.data == "result"); - alphaReceived = true; - }); + Router router("test_router", + std::tie(alphaEndpoint, betaEndpoint)); - router.bind<1, JOB>([&betaReceived](const Message& m) + SECTION("calls the correct callback when message is received") { - REQUIRE(m.subject == JOB); - REQUIRE(m.data == "job"); - betaReceived = true; - }); - - // Trigger the beta callback - alpha.send({"", JOB, "job"}); - router.pollStep(100ms); - REQUIRE(betaReceived); - - // Trigger the alpha callback - beta.send({"", RESULT, "result"}); - router.pollStep(100ms); - REQUIRE(alphaReceived); + bool idleCalled = false; + + Message msg{"", HEARTBEAT, ""}; + alpha.send(msg); + router.poll([&idleCalled]() { idleCalled = true; }); + + REQUIRE(betaEndpoint.handledHeartbeat == true); + REQUIRE(idleCalled == true); + } } diff --git a/src/test/socket.cpp b/src/test/socket.cpp index 693128f..593a26c 100644 --- a/src/test/socket.cpp +++ b/src/test/socket.cpp @@ -13,89 +13,168 @@ #include "comms/socket.hpp" using namespace stateline::comms; +using namespace std::chrono_literals; -TEST_CASE("Can create PAIR sockets", "[socket]") +TEST_CASE("can send messages over PAIR-PAIR SocketBases", "[socket_base]") { zmq::context_t ctx{1}; - Socket alpha{ctx, zmq::socket_type::pair, "alpha", NO_LINGER}; - REQUIRE(alpha.name() == "alpha"); - - Socket beta{ctx, zmq::socket_type::pair, "beta", NO_LINGER}; - REQUIRE(beta.name() == "beta"); + SECTION("constructor correctly initialises name") + { + SocketBase alpha{ctx, zmq::socket_type::pair, "alpha"}; + REQUIRE(alpha.name() == "alpha"); + + SocketBase beta{ctx, zmq::socket_type::pair, "beta"}; + REQUIRE(beta.name() == "beta"); + + SECTION("can bind and connect") + { + alpha.bind("inproc://alpha"); + beta.connect("inproc://alpha"); + + SECTION("can send and receive") + { + for (int i = 0; i < 3; i++) + { + alpha.send("beta", std::to_string(i)); + + const auto result = beta.recv(); + REQUIRE(result.first == "beta"); + REQUIRE(result.second == std::to_string(i)); + } + } + } + } } -TEST_CASE("Can bind and connect PAIR-PAIR", "[socket]") +TEST_CASE("can send messages over REQ-REP SocketBases", "[socket_base]") { zmq::context_t ctx{1}; - Socket alpha{ctx, zmq::socket_type::pair, "alpha", NO_LINGER}; - alpha.bind("inproc://alpha"); + SocketBase req{ctx, zmq::socket_type::req, "req"}; + SocketBase rep{ctx, zmq::socket_type::rep, "rep"}; + + SECTION("can bind and connect") + { + rep.bind("inproc://test"); + req.connect("inproc://test"); + + SECTION("can send and receive") + { + req.send("", "data"); - Socket beta{ctx, zmq::socket_type::pair, "beta", NO_LINGER}; - beta.connect("inproc://alpha"); + const auto result = rep.recv(); + REQUIRE(result.first == ""); + REQUIRE(result.second == "data"); + } + } } -TEST_CASE("Can send messages over PAIR-PAIR", "[socket]") + +TEST_CASE("can send messages over ROUTER-DEALER SocketBases", "[socket_base]") { zmq::context_t ctx{1}; - Socket alpha{ctx, zmq::socket_type::pair, "alpha", NO_LINGER}; - alpha.bind("inproc://alpha"); + SocketBase router{ctx, zmq::socket_type::router, "router"}; + router.bind("tcp://*:5174"); + + SocketBase dealer{ctx, zmq::socket_type::dealer, "dealer"}; + dealer.setIdentity("dealer"); + dealer.connect("tcp://localhost:5174"); - Socket beta{ctx, zmq::socket_type::pair, "beta", NO_LINGER}; - beta.connect("inproc://alpha"); + for (int i = 0; i < 3; i++) + { + // When ROUTER receives from DEALER, there should be the address of the DEALER. + dealer.send("", std::to_string(i)); - for (int i = 0; i < 3; i++) { - Message m{"beta", JOB, std::to_string(i)}; - alpha.send(m); + const auto result1 = router.recv(); + REQUIRE(result1.first == "dealer"); + REQUIRE(result1.second == std::to_string(i)); - auto result = beta.recv(); - REQUIRE(result.address == "beta"); - REQUIRE(result.subject == JOB); - REQUIRE(result.data == std::to_string(i)); + // When DEALER receives from ROUTER, there should be no address. + router.send("dealer", std::to_string(i)); + + const auto result2 = dealer.recv(); + REQUIRE(result2.first == ""); + REQUIRE(result2.second == std::to_string(i)); } } -TEST_CASE("Can bind and connect ROUTER-DEALER", "[socket]") +TEST_CASE("SocketBase keeps track of heartbeats", "[socket_base]") { zmq::context_t ctx{1}; - Socket router{ctx, zmq::socket_type::router, "router", NO_LINGER}; - router.bind("tcp://*:5000"); + SocketBase router{ctx, zmq::socket_type::router, "router"}; + router.bind("tcp://*:5174"); + + SocketBase dealer{ctx, zmq::socket_type::dealer, "dealer"}; + dealer.setIdentity("dealer"); + dealer.connect("tcp://localhost:5174"); + + SECTION("ignores incoming message if connection is not registered") + { + dealer.send("", "hi"); + router.recv(); + + REQUIRE(router.heartbeats().numConnections() == 0); + } + + SECTION("updates heartbeat manager when registering a new connection") + { + router.startHeartbeats("dealer", 1s); - Socket dealer{ctx, zmq::socket_type::dealer, "dealer", NO_LINGER}; - dealer.connect("tcp://localhost:5000"); + REQUIRE(router.heartbeats().numConnections() == 1); + + SECTION("updates last send time when sending") + { + const auto lastSendTime = router.heartbeats().lastSendTime("dealer"); + + router.send("dealer", "hi"); + + REQUIRE(router.heartbeats().lastSendTime("dealer") > lastSendTime); + } + + SECTION("updates last recv time when receiving") + { + const auto lastRecvTime = router.heartbeats().lastRecvTime("dealer"); + + dealer.send("", "hi"); + router.recv(); + + REQUIRE(router.heartbeats().lastRecvTime("dealer") > lastRecvTime); + } + } } -TEST_CASE("Can send messages over ROUTER-DEALER", "[socket]") +TEST_CASE("Can send messages over ROUTER-DEALER Sockets", "[socket]") { zmq::context_t ctx{1}; - Socket router{ctx, zmq::socket_type::router, "router", NO_LINGER}; + Socket router{ctx, zmq::socket_type::router, "router"}; router.bind("tcp://*:5174"); - Socket dealer{ctx, zmq::socket_type::dealer, "dealer", NO_LINGER}; + Socket dealer{ctx, zmq::socket_type::dealer, "dealer"}; dealer.setIdentity("dealer"); dealer.connect("tcp://localhost:5174"); - for (int i = 0; i < 3; i++) { + for (int i = 0; i < 3; i++) + { // When ROUTER receives from DEALER, there should be the address of the DEALER. - Message m1{"", JOB, std::to_string(i)}; - dealer.send(m1); + Message msg1{"", JOB, std::to_string(i)}; + dealer.send(msg1); - auto result1 = router.recv(); + const auto result1 = router.recv(); REQUIRE(result1.address == "dealer"); REQUIRE(result1.subject == JOB); REQUIRE(result1.data == std::to_string(i)); // When DEALER receives from ROUTER, there should be no address. - Message m2{"dealer", JOB, std::to_string(i)}; - router.send(m2); + Message msg2{"dealer", RESULT, std::to_string(i)}; + router.send(msg2); - auto result2 = dealer.recv(); + const auto result2 = dealer.recv(); REQUIRE(result2.address == ""); - REQUIRE(result2.subject == JOB); + REQUIRE(result2.subject == RESULT); REQUIRE(result2.data == std::to_string(i)); } } diff --git a/src/test/worker.cpp b/src/test/worker.cpp new file mode 100644 index 0000000..952882a --- /dev/null +++ b/src/test/worker.cpp @@ -0,0 +1,35 @@ +//! Tests for worker. +//! +//! \file comms/tests/worker.cpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include "catch/catch.hpp" + +#include "comms/worker.hpp" +#include "comms/protobuf.hpp" + +using namespace stateline::comms; + +constexpr const char* DELEGATOR_ADDR = "tcp://*:5000"; + +WorkerSettings workerSettings() +{ + WorkerSettings settings; + settings.networkAddress = DELEGATOR_ADDR; + + return settings; +} + +TEST_CASE("Can connect to delegator and worker", "[worker]") +{ + zmq::context_t ctx{1}; + + Socket delegator{ctx, zmq::socket_type::router, "toRequester"}; + delegator.bind(DELEGATOR_ADDR); + + Worker worker{ctx, settings}; +} From 2f81ea471d41ba938fc79c0c72c8809f624625a0 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 09:23:32 +1000 Subject: [PATCH 03/28] Passing tests for agent --- src/comms/agent.cpp | 57 +++++++++---------- src/comms/agent.hpp | 21 ++++++- src/comms/binary.hpp | 105 +++++++++++++++------------------- src/comms/endpoint.hpp | 8 +++ src/comms/protocol.hpp | 121 ++++++++++++++++++++++++++++++++++++++++ src/test/agent.cpp | 124 ++++++++++++++++++++++++++++++----------- src/test/binary.cpp | 41 +++++++------- 7 files changed, 331 insertions(+), 146 deletions(-) create mode 100644 src/comms/protocol.hpp diff --git a/src/comms/agent.cpp b/src/comms/agent.cpp index 125ce87..1787399 100644 --- a/src/comms/agent.cpp +++ b/src/comms/agent.cpp @@ -11,8 +11,8 @@ #include "comms/agent.hpp" #include "comms/endpoint.hpp" -#include "comms/protobuf.hpp" #include "comms/router.hpp" +#include "comms/protocol.hpp" #include @@ -20,29 +20,19 @@ namespace stateline { namespace comms { -namespace { - -struct AgentState +Agent::State::State(Socket& worker, Socket& network) + : worker{worker} + , network{network} + , workerWaiting{true} { - Socket& worker; - Socket& network; - std::queue queue; - bool workerWaiting; - - AgentState(Socket& worker, Socket& network) - : worker{worker} - , network{network} - , workerWaiting{false} - { - } -}; +} -struct WorkerEndpoint : Endpoint +struct Agent::WorkerEndpoint : Endpoint { - AgentState& agent; + Agent::State& agent; std::chrono::seconds timeout; - WorkerEndpoint(AgentState& agent, std::chrono::seconds timeout) + WorkerEndpoint(Agent::State& agent, std::chrono::seconds timeout) : Endpoint{agent.worker} , agent{agent} , timeout{timeout} @@ -51,9 +41,9 @@ struct WorkerEndpoint : Endpoint void onHello(const Message& m) { - messages::Hello hello; - hello.set_hb_timeout_secs(timeout.count()); - agent.network.send({"", HELLO, protobufToString(hello)}); + protocol::Hello hello; + hello.hbTimeoutSecs = timeout.count(); + agent.network.send({"", HELLO, serialise(hello)}); } void onResult(const Message& m) @@ -72,11 +62,11 @@ struct WorkerEndpoint : Endpoint } }; -struct NetworkEndpoint : Endpoint +struct Agent::NetworkEndpoint : Endpoint { - AgentState& agent; + Agent::State& agent; - NetworkEndpoint(AgentState& agent) + NetworkEndpoint(Agent::State& agent) : Endpoint{agent.network} , agent{agent} { @@ -84,16 +74,21 @@ struct NetworkEndpoint : Endpoint void onWelcome(const Message& m) { - const auto welcome = stringToProtobuf(m.data); - agent.network.startHeartbeats(m.address, std::chrono::seconds{welcome.hb_timeout_secs()}); + const auto welcome = protocol::unserialise(m.data); + agent.network.startHeartbeats(m.address, std::chrono::seconds{welcome.hbTimeoutSecs}); } void onJob(const Message& m) { if (agent.workerWaiting) + { agent.worker.send(m); // Forward job to worker + agent.workerWaiting = false; + } else + { agent.queue.push(m); + } } void onBye(const Message& m) @@ -102,12 +97,11 @@ struct NetworkEndpoint : Endpoint } }; -} - Agent::Agent(zmq::context_t& ctx, const AgentSettings& settings) : settings_{settings} , worker_{ctx, zmq::socket_type::rep, "toWorker"} , network_{ctx, zmq::socket_type::dealer, "toNetwork"} + , state_{worker_, network_} { // Initialise the local sockets worker_.bind(settings.bindAddress); @@ -124,9 +118,8 @@ void Agent::poll() void Agent::start(bool& running) { - AgentState agent{worker_, network_}; - WorkerEndpoint worker{agent, settings_.heartbeatTimeout}; - NetworkEndpoint network{agent}; + WorkerEndpoint worker{state_, settings_.heartbeatTimeout}; + NetworkEndpoint network{state_}; Router router{"agent", std::tie(worker, network)}; diff --git a/src/comms/agent.hpp b/src/comms/agent.hpp index 76bd067..9b03228 100644 --- a/src/comms/agent.hpp +++ b/src/comms/agent.hpp @@ -10,13 +10,14 @@ #pragma once +#include "endpoint.hpp" +#include "settings.hpp" + #include +#include #include -#include "settings.hpp" -#include "endpoint.hpp" - namespace stateline { namespace comms { //! An agent provides an interface between the delegator and worker. @@ -42,10 +43,24 @@ class Agent void start(bool& running); private: + struct State + { + Socket& worker; + Socket& network; + std::queue queue; + bool workerWaiting; + + State(Socket& worker, Socket& network); + }; + + struct WorkerEndpoint; + struct NetworkEndpoint; + AgentSettings settings_; Socket worker_; Socket network_; + State state_; }; } } diff --git a/src/comms/binary.hpp b/src/comms/binary.hpp index ef9624a..2713af2 100644 --- a/src/comms/binary.hpp +++ b/src/comms/binary.hpp @@ -15,73 +15,56 @@ namespace stateline { namespace comms { -template -struct PackSize; - -template -struct PackSize -{ - static constexpr std::size_t value = sizeof(T) + PackSize::value; -}; - -template <> -struct PackSize<> { static constexpr std::size_t value = 0; }; - -namespace detail { - -char* packBufferImpl(char* buf) { return buf; } - -template -char* packBufferImpl(char* buf, T val, Args... args) -{ - memcpy(buf, reinterpret_cast(&val), sizeof(val)); - return packBufferImpl(buf + sizeof(val), args...); -} - -} // namespace detail - -template -std::string packBuffer(Args... args) +template +void packValue(std::string& buf, T& val) { - // Preallocate the buffer - std::string buffer(PackSize::value, ' '); - detail::packBufferImpl(&buffer[0], args...); - return buffer; + buf.append(reinterpret_cast(&val), sizeof(T)); } -namespace detail { - -// TODO: there's gotta be a better way of doing this -template -typename std::enable_if< - sizeof...(Args) == 0, - std::pair, Iterator> ->::type unpackBufferImpl(Iterator first, Iterator, Done... done) +template +void packRange(std::string& buf, const T *first, const T *last) { - return {std::forward_as_tuple(done...), first}; + buf.append(reinterpret_cast(first), (last - first) * sizeof(T)); } -template -std::pair, Iterator> unpackBufferImpl(Iterator first, Iterator last, Done... done) +struct Unpacker { - assert(std::distance(last, first) >= sizeof(T)); - - T val = reinterpret_cast(*first); - return unpackBufferImpl(first + sizeof(T), last, done..., val); -} - -} - -template -std::pair, Iterator> unpackBuffer(Iterator first, Iterator last) -{ - return detail::unpackBufferImpl(first, last); -} - -template -std::tuple unpackBuffer(const std::string& str) -{ - return detail::unpackBufferImpl(str.begin(), str.end()).first; -} + const char *first; + const char *last; + + explicit Unpacker(const std::string& buf) + : first{buf.data()}, last{buf.data() + buf.size()} + { + } + + template + void unpackValue(T& val) + { + assert(first + sizeof(T) <= last); + + val = reinterpret_cast(*first); + first += sizeof(T); + } + + template + T unpackValue() + { + T val; + unpackValue(val); + return val; + } + + template + void unpackRest(Container& container) + { + using T = typename Container::value_type; + assert((last - first) % sizeof(T) == 0); + + container.reserve((last - first) / sizeof(T)); + + for (; first != last; first += sizeof(T)) + container.push_back(reinterpret_cast(*first)); + } +}; } } diff --git a/src/comms/endpoint.hpp b/src/comms/endpoint.hpp index 320ddb8..cd3e567 100644 --- a/src/comms/endpoint.hpp +++ b/src/comms/endpoint.hpp @@ -51,6 +51,14 @@ class Endpoint self().onWelcome(m); break; + case JOB: + self().onJob(m); + break; + + case RESULT: + self().onResult(m); + break; + default: // TODO: unrecognised subject onDefault(m); diff --git a/src/comms/protocol.hpp b/src/comms/protocol.hpp new file mode 100644 index 0000000..de14f01 --- /dev/null +++ b/src/comms/protocol.hpp @@ -0,0 +1,121 @@ +//! Contains protocol messages. +//! +//! \file comms/protocol.hpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#pragma once + +#include "comms/binary.hpp" + +namespace stateline { namespace comms { namespace protocol { + +struct Hello +{ + std::uint32_t hbTimeoutSecs; + + std::string serialise() const + { + std::string buffer; + buffer.reserve(4); + + packValue(buffer, hbTimeoutSecs); + return buffer; + } + + void unserialise(const std::string& str) + { + Unpacker p{str}; + p.unpackValue(hbTimeoutSecs); + } +}; + +struct Welcome +{ + std::uint32_t hbTimeoutSecs; + + std::string serialise() const + { + std::string buffer; + buffer.reserve(4); + + packValue(buffer, hbTimeoutSecs); + return buffer; + } + + void unserialise(const std::string& str) + { + Unpacker p{str}; + p.unpackValue(hbTimeoutSecs); + } +}; + +struct Job +{ + std::uint32_t id; + std::uint32_t type; + std::vector data; + + std::string serialise() const + { + std::string buffer; + buffer.reserve(4 + 4 + data.size() * 4); + + packValue(buffer, id); + packValue(buffer, type); + packRange(buffer, data.data(), data.data() + data.size()); + + return buffer; + } + + void unserialise(const std::string& str) + { + Unpacker p{str}; + p.unpackValue(id); + p.unpackValue(type); + p.unpackRest(data); + } +}; + +struct Result +{ + std::uint32_t id; + float data; + + std::string serialise() const + { + std::string buffer; + buffer.reserve(4 + 4); + + packValue(buffer, id); + packValue(buffer, data); + + return buffer; + } + + void unserialise(const std::string& str) + { + Unpacker p{str}; + p.unpackValue(id); + p.unpackValue(data); + } +}; + +template +std::string serialise(const T& t) +{ + return t.serialise(); +} + +template +T unserialise(const std::string& str) +{ + T t; + t.unserialise(str); + return t; +} + +} } } diff --git a/src/test/agent.cpp b/src/test/agent.cpp index f98ee85..8fe5aa9 100644 --- a/src/test/agent.cpp +++ b/src/test/agent.cpp @@ -10,7 +10,8 @@ #include "catch/catch.hpp" #include "comms/agent.hpp" -#include "comms/protobuf.hpp" +#include "comms/binary.hpp" +#include "comms/protocol.hpp" #include @@ -43,73 +44,134 @@ TEST_CASE("agent can connect to network and worker", "[agent]") agentAddress = msg.address; REQUIRE(msg.subject == HELLO); - const auto hello = stringToProtobuf(msg.data); - REQUIRE(hello.hb_timeout_secs() == 10); + const auto hello = protocol::unserialise(msg.data); + REQUIRE(hello.hbTimeoutSecs == 10); } SECTION("starts heartbeats after WELCOME from network") { - messages::Welcome welcome; - welcome.set_hb_timeout_secs(1); + protocol::Welcome welcome; + welcome.hbTimeoutSecs = 10; - REQUIRE(network.send({ agentAddress, WELCOME, protobufToString(welcome) }) == true); + REQUIRE(network.send({ agentAddress, WELCOME, serialise(welcome) }) == true); agent.poll(); - // TODO: Should have received a heartbeat - { - //const auto msg = network.recv(); - //REQUIRE(msg.subject == HEARTBEAT); - } + // TODO: SECTION("forwards JOB from network to worker") { { - messages::Job job; - job.set_id(1); - job.set_job_type(2); - job.add_data(1); - - REQUIRE(network.send({ agentAddress, JOB, protobufToString(job) }) == true); + protocol::Job job; + job.id = 1; + job.type = 2; + job.data.push_back(1); + job.data.push_back(2); + job.data.push_back(3); + + REQUIRE(network.send({ agentAddress, JOB, serialise(job) }) == true); } agent.poll(); - // TODO: should have received a JOB + { + const auto msg = worker.recv(); + REQUIRE(msg.subject == JOB); + + const auto job = protocol::unserialise(msg.data); + + REQUIRE(job.id == 1); + REQUIRE(job.type == 2); + REQUIRE(job.data.size() == 3); + REQUIRE(job.data[0] == 1); + REQUIRE(job.data[1] == 2); + REQUIRE(job.data[2] == 3); + } SECTION("forwards RESULT from worker to network") { - //REQUIRE(worker.send({ "", RESULT, "" }) == true); + protocol::Result result; + result.id = 1; + result.data = 4; + + REQUIRE(worker.send({ "", RESULT, serialise(result) }) == true); agent.poll(); - // TODO: should have received a RESULT + { + const auto msg = network.recv(); + REQUIRE(msg.subject == RESULT); + + const auto result = protocol::unserialise(msg.data); + REQUIRE(result.id == 1); + REQUIRE(result.data == 4); + } } SECTION("queues up JOB if worker is busy") { { - messages::Job job; - job.set_id(2); - job.set_job_type(2); - job.add_data(1); + protocol::Job job; + job.id = 2; + job.type = 2; + job.data.push_back(1); - REQUIRE(network.send({ agentAddress, JOB, protobufToString(job) }) == true); + REQUIRE(network.send({ agentAddress, JOB, serialise(job) }) == true); } agent.poll(); - // TODO should have queued - SECTION("forwards RESULT from worker to network and sends queued JOB") { - //REQUIRE(worker.send({ "", RESULT, "" }) == true); + { + protocol::Result result; + result.id = 1; + result.data = 4; + + REQUIRE(worker.send({ "", RESULT, serialise(result) }) == true); + } + agent.poll(); - // TODO: should have received a RESULT - // TODO: should send the queued job + { + const auto msg = network.recv(); + REQUIRE(msg.subject == RESULT); + + const auto result = protocol::unserialise(msg.data); + REQUIRE(result.id == 1); + REQUIRE(result.data == 4); + } + + { + const auto msg = worker.recv(); + REQUIRE(msg.subject == JOB); + + const auto job = protocol::unserialise(msg.data); + + REQUIRE(job.id == 2); + REQUIRE(job.type == 2); + REQUIRE(job.data.size() == 1); + REQUIRE(job.data[0] == 1); + } SECTION("forwards RESULT from worker to network") { - // TODO: should have received a RESULT + { + protocol::Result result; + result.id = 2; + result.data = 5; + + REQUIRE(worker.send({ "", RESULT, serialise(result) }) == true); + } + + agent.poll(); + + { + const auto msg = network.recv(); + REQUIRE(msg.subject == RESULT); + + const auto result = protocol::unserialise(msg.data); + REQUIRE(result.id == 2); + REQUIRE(result.data == 5); + } } } } diff --git a/src/test/binary.cpp b/src/test/binary.cpp index 2dba9f6..a1005df 100644 --- a/src/test/binary.cpp +++ b/src/test/binary.cpp @@ -13,29 +13,32 @@ using namespace stateline::comms; -TEST_CASE("can pack empty tuple", "[binary]") +TEST_CASE("can pack and unpack one value", "[binary]") { - REQUIRE(packBuffer() == ""); -} + std::int32_t a = 42; -TEST_CASE("can unpack empty string", "[binary]") -{ - std::string str = ""; - const auto result = unpackBuffer(str.begin(), str.end()); - REQUIRE(std::tuple_size::value == 0); - REQUIRE(result.second == str.end()); -} + std::string buf; + packValue(buf, a); -TEST_CASE("can pack and unpack one item", "[binary]") -{ - const auto result = unpackBuffer(packBuffer(std::int32_t{42})); - REQUIRE(std::get<0>(result) == 42); + Unpacker p{buf}; + const auto aa = p.unpackValue(); + + REQUIRE(aa == 42); } -TEST_CASE("can pack and unpack two items", "[binary]") +TEST_CASE("can pack and unpack two values", "[binary]") { - const auto result = unpackBuffer(packBuffer(std::int32_t{42}, std::int8_t{1})); - REQUIRE(std::get<0>(result) == 42); - REQUIRE(std::get<1>(result) == 1); -} + std::int32_t a = 42; + std::int8_t b = 1; + + std::string buf; + packValue(buf, a); + packValue(buf, b); + Unpacker p{buf}; + const auto aa = p.unpackValue(); + const auto bb = p.unpackValue(); + + REQUIRE(aa == 42); + REQUIRE(bb == 1); +} From 6e94c2f430e91a08710759b03f7bd086fb4ebb42 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 09:57:51 +1000 Subject: [PATCH 04/28] Requester tests pass --- src/comms/binary.hpp | 2 +- src/comms/protocol.hpp | 63 +++++++++++++++++++++++++---- src/comms/requester.cpp | 26 ++++-------- src/comms/requester.hpp | 9 ++--- src/test/CMakeLists.txt | 3 +- src/test/agent.cpp | 1 - src/test/requester.cpp | 89 ++++++++++++++++------------------------- 7 files changed, 104 insertions(+), 89 deletions(-) diff --git a/src/comms/binary.hpp b/src/comms/binary.hpp index 2713af2..75a3c1e 100644 --- a/src/comms/binary.hpp +++ b/src/comms/binary.hpp @@ -16,7 +16,7 @@ namespace stateline { namespace comms { template -void packValue(std::string& buf, T& val) +void packValue(std::string& buf, const T& val) { buf.append(reinterpret_cast(&val), sizeof(T)); } diff --git a/src/comms/protocol.hpp b/src/comms/protocol.hpp index de14f01..30784f6 100644 --- a/src/comms/protocol.hpp +++ b/src/comms/protocol.hpp @@ -15,13 +15,16 @@ namespace stateline { namespace comms { namespace protocol { struct Hello { + std::pair jobTypesRange; std::uint32_t hbTimeoutSecs; std::string serialise() const { std::string buffer; - buffer.reserve(4); + buffer.reserve(1 + 1 + 4); + packValue(buffer, jobTypesRange.first); + packValue(buffer, jobTypesRange.second); packValue(buffer, hbTimeoutSecs); return buffer; } @@ -29,6 +32,8 @@ struct Hello void unserialise(const std::string& str) { Unpacker p{str}; + p.unpackValue(jobTypesRange.first); + p.unpackValue(jobTypesRange.second); p.unpackValue(hbTimeoutSecs); } }; @@ -57,17 +62,16 @@ struct Job { std::uint32_t id; std::uint32_t type; - std::vector data; + std::vector data; std::string serialise() const { std::string buffer; - buffer.reserve(4 + 4 + data.size() * 4); + buffer.reserve(4 + 4 + data.size() * sizeof(double)); packValue(buffer, id); packValue(buffer, type); packRange(buffer, data.data(), data.data() + data.size()); - return buffer; } @@ -83,16 +87,15 @@ struct Job struct Result { std::uint32_t id; - float data; + double data; std::string serialise() const { std::string buffer; - buffer.reserve(4 + 4); + buffer.reserve(4 + sizeof(double)); packValue(buffer, id); packValue(buffer, data); - return buffer; } @@ -104,6 +107,52 @@ struct Result } }; +struct BatchJob +{ + std::uint32_t id; + std::vector data; + + std::string serialise() const + { + std::string buffer; + buffer.reserve(4 + data.size() * sizeof(double)); + + packValue(buffer, id); + packRange(buffer, data.data(), data.data() + data.size()); + return buffer; + } + + void unserialise(const std::string& str) + { + Unpacker p{str}; + p.unpackValue(id); + p.unpackRest(data); + } +}; + +struct BatchResult +{ + std::uint32_t id; + std::vector data; + + std::string serialise() const + { + std::string buffer; + buffer.reserve(4 + data.size() * sizeof(double)); + + packValue(buffer, id); + packRange(buffer, data.data(), data.data() + data.size()); + return buffer; + } + + void unserialise(const std::string& str) + { + Unpacker p{str}; + p.unpackValue(id); + p.unpackRest(data); + } +}; + template std::string serialise(const T& t) { diff --git a/src/comms/requester.cpp b/src/comms/requester.cpp index c673616..ae62296 100644 --- a/src/comms/requester.cpp +++ b/src/comms/requester.cpp @@ -7,7 +7,7 @@ #include "comms/requester.hpp" -#include "comms/protobuf.hpp" +#include "comms/protocol.hpp" #include @@ -20,31 +20,21 @@ Requester::Requester(zmq::context_t& ctx, const std::string& addr) socket_.connect(addr); } -void Requester::submit(BatchID id, const std::vector& jobTypes, - const std::vector& data) +void Requester::submit(BatchID id, const std::vector& data) { - messages::BatchJob batchJob; - batchJob.set_id(id); + protocol::BatchJob batchJob; + batchJob.id = id; + batchJob.data = data; - for (const auto& jobType : jobTypes) - batchJob.add_job_type(jobType); - - for (auto x : data) - batchJob.add_data(x); - - socket_.send({"", BATCH_JOB, protobufToString(batchJob)}); + socket_.send({"", BATCH_JOB, serialise(batchJob)}); } std::pair> Requester::retrieve() { const auto msg = socket_.recv(); - const auto batchResult = stringToProtobuf(msg.data); - - std::vector data; - for (int i = 0; i < batchResult.data_size(); i++) - data.push_back(batchResult.data(i)); + const auto batchResult = protocol::unserialise(msg.data); - return {batchResult.id(), std::move(data)}; + return {batchResult.id, std::move(batchResult.data)}; } } } diff --git a/src/comms/requester.hpp b/src/comms/requester.hpp index 04b2fc2..961dc55 100644 --- a/src/comms/requester.hpp +++ b/src/comms/requester.hpp @@ -34,17 +34,14 @@ class Requester //! are retrieved they may not arrive in the order they were submitted. //! //! \param id The id of the batch - //! \param jobTypes The vector of jobs to compute //! \param data The data shared between all the jobs //! - void submit(BatchID id, const std::vector& jobTypes, - const std::vector& data); + void submit(BatchID id, const std::vector& data); //! Retrieves the results of a batch submitted previously. - //! This call blocks until the result of a batch is available. The order of the - //! results within the batch corresponds to the order of the submitted job types. + //! This call blocks until the result of a batch is available. //! - //! \returns A pair of the job id and the result. + //! \returns A pair of the job id and the results for each job type. //! std::pair> retrieve(); diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt index 1f04bfe..3f15a6a 100644 --- a/src/test/CMakeLists.txt +++ b/src/test/CMakeLists.txt @@ -21,8 +21,7 @@ ADD_EXECUTABLE(${test_suite_name} EXCLUDE_FROM_ALL endpoint.cpp router.cpp agent.cpp - #poll.cpp - #requester.cpp + requester.cpp #delegator.cpp diagnostics.cpp router.cpp socket.cpp # chainarray.cpp db.cpp ) diff --git a/src/test/agent.cpp b/src/test/agent.cpp index 8fe5aa9..57ce5ba 100644 --- a/src/test/agent.cpp +++ b/src/test/agent.cpp @@ -10,7 +10,6 @@ #include "catch/catch.hpp" #include "comms/agent.hpp" -#include "comms/binary.hpp" #include "comms/protocol.hpp" #include diff --git a/src/test/requester.cpp b/src/test/requester.cpp index bb25286..159dbba 100644 --- a/src/test/requester.cpp +++ b/src/test/requester.cpp @@ -1,6 +1,6 @@ -//! Tests for polling. +//! Tests for requester. //! -//! \file comms/tests/poll.cpp +//! \file comms/tests/requester.cpp //! \author Darren Shen //! \date 2016 //! \license Lesser General Public License version 3 or later @@ -10,13 +10,13 @@ #include "catch/catch.hpp" #include "comms/requester.hpp" -#include "comms/protobuf.hpp" +#include "comms/protocol.hpp" using namespace stateline::comms; constexpr const char* DELEGATOR_ADDR = "inproc://test"; -TEST_CASE("Can connect to inproc delegator", "[requester]") +TEST_CASE("can communicate with delegator", "[requester]") { zmq::context_t ctx{1}; @@ -24,55 +24,36 @@ TEST_CASE("Can connect to inproc delegator", "[requester]") delegator.bind(DELEGATOR_ADDR); Requester req{ctx, DELEGATOR_ADDR}; -} - -TEST_CASE("Can submit to the delegator", "[requester]") -{ - zmq::context_t ctx{1}; - - Socket delegator{ctx, zmq::socket_type::router, "toRequester"}; - delegator.bind(DELEGATOR_ADDR); - - Requester req{ctx, DELEGATOR_ADDR}; - req.submit(42, {1, 2}, {3, 4}); - - const auto message = delegator.recv(); - REQUIRE(message.subject == BATCH_JOB); - - const auto batchJob = stringToProtobuf(message.data); - - REQUIRE(batchJob.id() == 42); - REQUIRE(batchJob.job_type_size() == 2); - REQUIRE(batchJob.job_type(0) == 1); - REQUIRE(batchJob.job_type(1) == 2); - REQUIRE(batchJob.data_size() == 2); - REQUIRE(batchJob.data(0) == 3); - REQUIRE(batchJob.data(1) == 4); -} - -TEST_CASE("Can retrieve from the delegator", "[requester]") -{ - zmq::context_t ctx{1}; - - Socket delegator{ctx, zmq::socket_type::router, "toRequester"}; - delegator.bind(DELEGATOR_ADDR); - - Requester req{ctx, DELEGATOR_ADDR}; - req.submit(42, {1, 2}, {3, 4}); // Submit so delegator can get its address - - const auto reqAddr = delegator.recv().address; - - messages::BatchResult batchResult; - batchResult.set_id(42); - batchResult.add_data(1); - batchResult.add_data(2); - - delegator.send({reqAddr, BATCH_RESULT, protobufToString(batchResult)}); - - const auto result = req.retrieve(); - REQUIRE(result.first == 42); - REQUIRE(result.second.size() == 2); - REQUIRE(result.second[0] == 1); - REQUIRE(result.second[1] == 2); + SECTION("sends batch job to the delegator on submit") + { + req.submit(42, {3, 4}); + + const auto msg = delegator.recv(); + REQUIRE(msg.subject == BATCH_JOB); + + const auto batchJob = protocol::unserialise(msg.data); + REQUIRE(batchJob.id == 42); + REQUIRE(batchJob.data.size() == 2); + REQUIRE(batchJob.data[0] == 3); + REQUIRE(batchJob.data[1] == 4); + + const auto reqAddress = msg.address; + + SECTION("obtains batch result on retrieve") + { + protocol::BatchResult batchResult; + batchResult.id = 42; + batchResult.data.push_back(1); + batchResult.data.push_back(2); + + delegator.send({reqAddress, BATCH_RESULT, serialise(batchResult)}); + + const auto result = req.retrieve(); + REQUIRE(result.first == 42); + REQUIRE(result.second.size() == 2); + REQUIRE(result.second[0] == 1); + REQUIRE(result.second[1] == 2); + } + } } From 74c0fa0629f0a8a4da05ee6db8355b31f8f6b740 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 15:00:06 +1000 Subject: [PATCH 05/28] Delegator without job scheduling --- src/comms/CMakeLists.txt | 2 +- src/comms/delegator.cpp | 267 ++++++++++++++++++++----------------- src/comms/delegator.hpp | 91 +++++++------ src/comms/endpoint.hpp | 8 ++ src/comms/protocol.hpp | 4 +- src/comms/settings.hpp | 33 +++-- src/comms/utils.hpp | 35 +++++ src/test/CMakeLists.txt | 3 +- src/test/delegator.cpp | 281 +++++++++++++-------------------------- 9 files changed, 351 insertions(+), 373 deletions(-) create mode 100644 src/comms/utils.hpp diff --git a/src/comms/CMakeLists.txt b/src/comms/CMakeLists.txt index 14b2040..4644dcb 100644 --- a/src/comms/CMakeLists.txt +++ b/src/comms/CMakeLists.txt @@ -6,5 +6,5 @@ # Date: 2014 ADD_LIBRARY(commoncomms OBJECT message.cpp socket.cpp heartbeat.cpp) -ADD_LIBRARY(servercomms OBJECT requester.cpp) +ADD_LIBRARY(servercomms OBJECT requester.cpp delegator.cpp) ADD_LIBRARY(clientcomms OBJECT agent.cpp) diff --git a/src/comms/delegator.cpp b/src/comms/delegator.cpp index 6147e14..6aab893 100644 --- a/src/comms/delegator.cpp +++ b/src/comms/delegator.cpp @@ -1,6 +1,6 @@ -//! //! \file comms/delegator.cpp //! \author Lachlan McCalman +//! \author Darren Shen //! \date 2014 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA @@ -10,8 +10,8 @@ #include "comms/datatypes.hpp" #include "comms/endpoint.hpp" -#include "comms/protobuf.hpp" -#include "comms/thread.hpp" +#include "comms/protocol.hpp" +#include "comms/router.hpp" #include @@ -20,124 +20,163 @@ namespace stateline { namespace comms { -namespace { +Delegator::PendingBatch::PendingBatch(std::string address, std::vector data, std::size_t numJobTypes) + : address{std::move(address)} + , data{std::move(data)} + , results(numJobTypes) // Pre-allocate the vector + , numJobsDone{0} +{ +} + +Delegator::State::State(zmq::context_t& ctx, const DelegatorSettings& settings) + : requester{ctx, zmq::socket_type::router, "toRequester"} + , network{ctx, zmq::socket_type::router, "toNetwork"} + , settings{settings} +{ +} -struct RequesterEndpoint : Endpoint +void Delegator::State::addWorker(const std::string& address, const std::pair& jobTypesRange) { - Socket& worker; + Worker w{address, jobTypesRange}; + + // TODO: why not create lazily? + for (auto i = jobTypesRange.first; i <= jobTypesRange.second; ++i) + w.times.emplace(std::piecewise_construct, + std::forward_as_tuple(i), + std::forward_as_tuple(0.1)); // TODO make this a setting + + workers.emplace(address, w); - RequesterEndpoint(Socket& requester, Socket& worker) - : Endpoint(requester) - , worker(worker) + LOG(INFO)<< "Worker " << address << " connected, supporting jobtypes: "; // TODO +} + +void Delegator::State::addBatch(const std::string& address, JobID id, std::vector data) +{ + // Add the batch as a pending request. + auto ret = pending.emplace(std::piecewise_construct, + std::forward_as_tuple(id), + std::forward_as_tuple(address, std::move(data), settings.numJobTypes)); + + // Add each job in the batch to the queue. + for (JobType i = 0; i < settings.numJobTypes; i++) { + jobQueue.emplace_back(ret.first, i + 1); } - void onBatchJob(const Message& m) - { - const auto batchJob = stringToProtobuf(m.data); + VLOG(2) << pending.size() << " requests pending"; +} - VLOG(2) << "Received batch with " << batch.job_types_size() << " jobs"; +struct Delegator::RequesterEndpoint : Endpoint +{ + State& delegator; - // Add the batch as a pending request. - requests_.emplace(std::piecewise_construct, - std::forward_as_tuple(id), - std::forward_as_tuple(m.address, batchJob.data(), jobTypes.size())); + RequesterEndpoint(State& delegator) + : Endpoint{delegator.requester} + , delegator{delegator} + { + } - // Add each job in the batch to the queue. - for (std::size_t i = 0; i < batchJob.job_type_size(); i++) - { - jobQueue_.emplace_back(nextJobId_++, batchJob.job_type(i)); - } + void onBatchJob(const Message& m) + { + auto batchJob = protocol::unserialise(m.data); + VLOG(2) << "Received batch"; - VLOG(2) << requests_.size() << " requests pending"; + delegator.addBatch(m.address, batchJob.id, std::move(batchJob.data)); } }; -struct WorkerEndpoint : Endpoint +struct Delegator::NetworkEndpoint : Endpoint { - Socket& requester; + State& delegator; + JobID lastJobID; - WorkerEndpoint(Socket& worker, Socket& requester) - : Endpoint{worker} - , requester{requester} + NetworkEndpoint(State& delegator) + : Endpoint{delegator.network} + , delegator{delegator} + , lastJobID{0} { } void onHello(const Message& m) { - // add jobtypes - // TODO: job types + const auto hello = protocol::unserialise(m.data); + delegator.addWorker(m.address, hello.jobTypesRange); - const auto hello = stringToProtobuf(m.data); + // Use the more lenient timeout as the agreed timeout + const auto timeout = std::max(std::chrono::seconds{hello.hbTimeoutSecs}, + delegator.settings.heartbeatTimeout); + delegator.network.startHeartbeats(m.address, timeout); - Worker w{m.address, jobTypeRange}; - for (auto i = jobTypeRange.first; i < jobTypeRange.second; ++i) - w.times.emplace(i, CircularBuffer{10}); + // Send a WELCOME message to the worker + protocol::Welcome welcome; + welcome.hbTimeoutSecs = timeout.count(); + + delegator.network.send({m.address, WELCOME, serialise(welcome)}); + } + + void idle() + { + for (auto it = delegator.jobQueue.begin(); it != delegator.jobQueue.end(); ) + { + // TODO: find the best worker + Worker *worker = delegator.workers.size() == 0 ? nullptr : &delegator.workers.begin()->second; + if (!worker) + { + ++it; + continue; + } - workers_.emplace(m.address, w); + protocol::Job job; + job.id = ++lastJobID; + job.data = it->batch->second.data; - LOG(INFO)<< "Worker " << id << " connected, supporting jobtypes: "; // TODO + delegator.network.send({worker->address, JOB, serialise(job)}); - hb.connect(m.address, std::chrono::seconds{10}); // TODO + it->startTime = Clock::now(); + worker->inProgress.emplace(job.id, std::move(*it)); + + // TODO: investigate lazy removal + it = delegator.jobQueue.erase(it); + } } void onResult(const Message& m) { - const auto it = workers_.find(m.address); - if (it == workers_.end()) + // TODO: refactor into State + const auto it = delegator.workers.find(m.address); + if (it == delegator.workers.end()) return; - const auto result = protobufToString(m.data); - const Job& job = it->second.wip.at(result.id()); - - // timing information - const auto now = hrc::now(); - - // estimate time the worker spent on this job - const auto elapsedTime = now - job.startTime; + const auto result = protocol::unserialise(m.data); + Worker& worker = it->second; + Job& job = worker.inProgress.at(result.id); + PendingBatch& batch = job.batch->second; - const auto usecs = std::chrono::duration_cast(elapsedTime).count(); - it->times.at(j.type).push_back(usecs); - it->lastResultTime = now; + worker.times.at(job.type).add(std::chrono::duration_cast(Clock::now() - job.startTime).count()); - Request& req = requests_[j.batchID]; - req.results[j.jobTypeIndex] = result.data(); - req.numCompleted++; + batch.results[job.type - 1] = result.data; // job types are 1-indexed + batch.numJobsDone++; - if (req.numCompleted == req.results.size()) + if (batch.numJobsDone == batch.results.size()) { - messages::BatchResult batchResult; - batchResult.set_id(req.id); + protocol::BatchResult batchResult; + batchResult.id = job.batch->first; + batchResult.data = std::move(batch.results); - for (const auto& r : req.results) - batchResult.add_data(r); - - requester_.send({req.address, BATCH_RESULT, protobufToString(batchResult)}); - requests_.erase(job.batchID); + delegator.requester.send({batch.address, BATCH_RESULT, serialise(batchResult)}); + delegator.pending.erase(job.batch); } // Remove job from work in progress store - worker.wip.erase(job.id); + worker.inProgress.erase(result.id); } + /* void onBye(const Message& m) { hb.disconnect(m.address); } void onAny(const Message& m) { hb.update(m.address); } }; - // TODO: should this be a float? - uint timeForJob(const Delegator::Worker& w, uint jobType) - { - auto& times = w.times.at(jobType); - uint totalTime = std::accumulate(std::begin(times), std::end(times), 0); - uint avg; - if (times.size() > 0) - avg = totalTime / times.size(); - else - avg = 5; // very short initial guess to encourage testing - return avg; - } - // TODO: could we compute these lazily? i.e. each time a new job is assigned, // we update the expected finishing time? uint usTillDone(const Delegator::Worker& w, uint jobType) @@ -148,39 +187,48 @@ struct WorkerEndpoint : Endpoint //now add the expected time for the new job t += timeForJob(w, jobType); return t; - } - -} + }*/ +}; Delegator::Delegator(zmq::context_t& ctx, const DelegatorSettings& settings) - : requester_{ctx, ZMQ_ROUTER, "toRequester"} - , network_{ctx, ZMQ_ROUTER, "toNetwork"} - , msPollRate_{settings.msPollRate} - , hbSettings_{settings.heartbeat} - , nextJobId_{1} + : state_{ctx, settings} { // Initialise the local sockets - requester_.bind(DELEGATOR_SOCKET_ADDR); - network_.connect(settings); + state_.requester.bind(settings.bindAddress); + state_.network.connect(settings.networkAddress); - network_.setFallback([&](const Message& m) { sendFailed(m); }); + // TODO: network_.setFallback([&](const Message& m) { sendFailed(m); }); - network_.bind("tcp://*:" + std::to_string(settings.port)); + LOG(INFO) << "Delegator listening on " << settings.bindAddress; +} - LOG(INFO) << "Delegator listening on tcp://*:" << settings.port; +void Delegator::poll() +{ + bool running = false; // poll for one iteration + start(running); } void Delegator::start(bool& running) { - while (running) + RequesterEndpoint requester{state_}; + NetworkEndpoint network{state_}; + + Router router{"delegator", std::tie(requester, network)}; + + const auto onIdle = [&network]() { - poll(std::tie(requester_, worker_), pollWait_); + network.idle(); + // TODO: Ugly. + network.socket().heartbeats().idle(); + }; - idle(); - hb_.idle(); - } + do + { + router.poll(onIdle); + } while (running); } +/* Delegator::Worker* Delegator::bestWorker(uint jobType, uint maxJobs) { // TODO: can we do this using an STL algorithm? @@ -203,33 +251,6 @@ Delegator::Worker* Delegator::bestWorker(uint jobType, uint maxJobs) return best; } -void Delegator::idle() -{ - const uint maxJobs = 10; - auto i = std::begin(jobQueue_); - while (i != std::end(jobQueue_)) - { - auto worker = bestWorker(i->type, maxJobs); - if (!worker) - { - ++i; - continue; - } - - std::string& data = requests_[i->requesterID].data; - network_.send({worker->address, JOB, {std::to_string(i->type), i->id, data}}); - i->startTime = std::chrono::high_resolution_clock::now(); - worker->workInProgress.insert(std::make_pair(i->id, *i)); - - // TODO: could we avoid removing this? What if we just mark it as being removed, - // and ignore it when we're polling? We can reap these 'zombie' jobs whenever - // they get removed from the front of the queue (assuming there's no job starvation). - // This way, we can keep using a queue instead of a list, so we can get - // better performance through cache locality. - jobQueue_.erase(i++); - } -} - void Delegator::disconnectWorker(const std::string& addr) { const auto it = workers_.find(m.address); @@ -250,8 +271,6 @@ void Delegator::sendFailed(const Message& m) LOG(INFO) << "Failed to send to " << m.address; disconnectWorker(m.address); -} - -} // namespace stateline +} */ -} // namespace comms +} } diff --git a/src/comms/delegator.hpp b/src/comms/delegator.hpp index e601ea9..ff55ef1 100644 --- a/src/comms/delegator.hpp +++ b/src/comms/delegator.hpp @@ -11,22 +11,19 @@ #pragma once +#include "comms/datatypes.hpp" +#include "comms/socket.hpp" +#include "comms/utils.hpp" #include "settings.hpp" -#include "heartbeat.hpp" -#include "common/circularbuffer.hpp" #include -#include +#include #include #include #include namespace stateline { namespace comms { -//! Address that the requesters connect their sockets to. -// const std::string DELEGATOR_SOCKET_ADDR = "inproc://delegator"; -const std::string DELEGATOR_SOCKET_ADDR = "ipc:///tmp/sl_delegator.socket"; - //! Responsible for allocating jobs to workers. //! class Delegator @@ -42,70 +39,84 @@ class Delegator Delegator(const Delegator&) = delete; Delegator& operator=(const Delegator&) = delete; + void poll(); + void start(bool& running); private: - using std::chrono::high_resolution_clock = hrc; + using Clock = std::chrono::high_resolution_clock; - struct Request + struct PendingBatch { - std::string address; - std::vector data; - std::vector results; - int nDone; + std::string address; // need to know who to send this back to + std::vector data; // the batch job data + std::vector results; // table of pending results + int numJobsDone; // number of completed jobs so far - Request(std::string address, std::vector data, std::size_t numJobTypes) - : address{std::move(address)} - , data{std::move(data)} - , results(numJobTypes) // Pre-allocate the vector - , nDone{0} - { - } + PendingBatch(std::string address, std::vector data, std::size_t numJobTypes); }; + using PendingBatchContainer = std::map; + struct Job { + PendingBatchContainer::iterator batch; JobType type; - JobID id; - BatchID batchID; - hrc::time_point startTime; + Clock::time_point startTime; - Request(JobID id, JobType type, + Job(PendingBatchContainer::iterator batch, JobType type) + : batch(batch) + , type(type) + { + } }; struct Worker { std::string address; - std::pair jobTypesRange; //! - - //! - std::map workInProgress; - std::map> times; - hrc::time_point lastResultTime; + std::pair jobTypesRange; + std::map inProgress; + std::map> times; - Worker(std::vector address, - std::pair jobTypesRange) + Worker(std::string address, + const std::pair& jobTypesRange) : address{std::move(address)} - , jobTypesRange{std::move(jobTypesRange)} - , lastResultTime{hrc::now()} + , jobTypesRange{jobTypesRange} { } }; + /* void idle(); // TODO: does this need to be a member function? - Worker* bestWorker(uint jobType, uint maxJobs); + Worker* bestWorker(uint jobType, uint maxJobs);*/ + + struct State + { + Socket requester; + Socket network; + DelegatorSettings settings; + std::map workers; + PendingBatchContainer pending; + std::list jobQueue; + + State(zmq::context_t& ctx, const DelegatorSettings& settings); + + void addWorker(const std::string& address, const std::pair& jobTypeRange); + + void addBatch(const std::string& address, JobID id, std::vector data); + }; - // Sockets - Socket requester_; - Socket worker_; + struct RequesterEndpoint; + struct NetworkEndpoint; - std::map workers_; + State state_; + /* std::map requests_; std::list jobQueue_; - JobID nextJobId_; + JobID nextJobId_;*/ }; } } diff --git a/src/comms/endpoint.hpp b/src/comms/endpoint.hpp index cd3e567..b8e5361 100644 --- a/src/comms/endpoint.hpp +++ b/src/comms/endpoint.hpp @@ -59,6 +59,14 @@ class Endpoint self().onResult(m); break; + case BATCH_JOB: + self().onBatchJob(m); + break; + + case BATCH_RESULT: + self().onBatchResult(m); + break; + default: // TODO: unrecognised subject onDefault(m); diff --git a/src/comms/protocol.hpp b/src/comms/protocol.hpp index 30784f6..2f76607 100644 --- a/src/comms/protocol.hpp +++ b/src/comms/protocol.hpp @@ -15,13 +15,13 @@ namespace stateline { namespace comms { namespace protocol { struct Hello { - std::pair jobTypesRange; + std::pair jobTypesRange; std::uint32_t hbTimeoutSecs; std::string serialise() const { std::string buffer; - buffer.reserve(1 + 1 + 4); + buffer.reserve(4 + 4 + 4); packValue(buffer, jobTypesRange.first); packValue(buffer, jobTypesRange.second); diff --git a/src/comms/settings.hpp b/src/comms/settings.hpp index 0d0a86a..120eaa1 100644 --- a/src/comms/settings.hpp +++ b/src/comms/settings.hpp @@ -53,27 +53,26 @@ struct HeartbeatSettings //! struct DelegatorSettings { - //! The rate at which the receive sockets are polled. - int msPollRate; + //! The address of this delegator which the requester connects to. + std::string bindAddress; - //! The port number that the delegator listens on. - uint port; + //! The address of the agent to connect to. + std::string networkAddress; - //! Settings for the heartbeat monitoring. - HeartbeatSettings heartbeat; + //! How long without heartbeats is considered time out. + std::chrono::seconds heartbeatTimeout; - //! number of job types. - uint nJobTypes; + //! Number of job types per batch job. + std::size_t numJobTypes; - //! Default delegator settings - static DelegatorSettings Default(uint port) + //! Construct default agent settings. + //! + DelegatorSettings(std::string bindAddress, std::string networkAddress) + : bindAddress{std::move(bindAddress)} + , networkAddress{std::move(networkAddress)} { - DelegatorSettings settings; - settings.msPollRate = 10; - settings.port = port; - settings.heartbeat = HeartbeatSettings::DelegatorDefault(); - settings.nJobTypes = 1; - return settings; + heartbeatTimeout = std::chrono::seconds{15}; + numJobTypes = 1; } }; @@ -109,7 +108,7 @@ struct AgentSettings //! The address of the delegator to connect to. std::string networkAddress; - //! How long without heartbeats is considered times out. + //! How long without heartbeats is considered time out. std::chrono::seconds heartbeatTimeout; //! Construct default agent settings. diff --git a/src/comms/utils.hpp b/src/comms/utils.hpp new file mode 100644 index 0000000..d23200d --- /dev/null +++ b/src/comms/utils.hpp @@ -0,0 +1,35 @@ +//! Utilities for comms. +//! +//! \file comms/utils.hpp +//! \author Darren Shen +//! \date 2016 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +namespace stateline { namespace comms { + +template +class ExpMovingAverage +{ +public: + ExpMovingAverage(float alpha) + : alpha_{alpha} + , avg_{0} + { + assert(alpha >= 0.0 && alpha <= 1.0); + } + + T average() const { return avg_; } + + void add(const T& val) + { + avg_ = (alpha_ * val) + (1.0 - alpha_) * avg_; + } + +private: + float alpha_; + T avg_; +}; + +} } diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt index 3f15a6a..c8da340 100644 --- a/src/test/CMakeLists.txt +++ b/src/test/CMakeLists.txt @@ -22,7 +22,8 @@ ADD_EXECUTABLE(${test_suite_name} EXCLUDE_FROM_ALL router.cpp agent.cpp requester.cpp - #delegator.cpp diagnostics.cpp router.cpp socket.cpp + delegator.cpp + #diagnostics.cpp # chainarray.cpp db.cpp ) diff --git a/src/test/delegator.cpp b/src/test/delegator.cpp index 2ef3ca7..c275478 100644 --- a/src/test/delegator.cpp +++ b/src/test/delegator.cpp @@ -1,218 +1,123 @@ +//! Tests for delegator. //! -//! \file comms/tests/message.cpp -//! \author Lachlan McCalman +//! \file comms/tests/delegator.cpp //! \author Darren Shen -//! \date 2015 +//! \date 2016 //! \license Lesser General Public License version 3 or later //! \copyright (c) 2014, NICTA //! -#include +#include "catch/catch.hpp" #include "comms/delegator.hpp" +#include "comms/protocol.hpp" -#include "comms/socket.hpp" -#include "comms/thread.hpp" +#include +#include using namespace stateline::comms; +using namespace std::chrono_literals; -// Custom print for message to make it easier to debug -namespace stateline +TEST_CASE("delegator follows protocol", "[delegator]") { - namespace comms - { - void PrintTo(const Message& m, std::ostream* os) - { - *os << "|"; - for (const auto& addr : m.address) - { - *os << addr << "|"; - } - *os << m.subject << "|"; - for (const auto& data : m.data) - { - *os << data << "|"; - } - } - } -} + zmq::context_t ctx{1}; -Message receiveIgnoreHBs(Socket& socket) -{ - while (true) { - Message m = socket.receive(); - if (m.subject != HEARTBEAT) - return m; - } -} - -class DelegatorTest : public testing::Test -{ -public: - DelegatorTest() - : context_{1}, - worker_{context_, ZMQ_DEALER, "mockWorker", 0}, - requester_{context_, ZMQ_DEALER, "mockRequester", -1}, - running_{false} - { - DelegatorSettings settings = DelegatorSettings::Default(5555); - settings.msPollRate = 100; - settings.heartbeat.msPollRate = 100; - settings.heartbeat.msTimeout = 500; - settings.nJobTypes = 10; + DelegatorSettings settings{"ipc://test_delegator", "ipc://test_network"}; + settings.heartbeatTimeout = 10s; + settings.numJobTypes = 3; - running_ = true; - delFuture_ = stateline::startInThread<::stateline::comms::Delegator>(running_, std::ref(context_), std::ref(settings)); + Socket network{ctx, zmq::socket_type::dealer, "network"}; + network.bind(settings.networkAddress); - worker_.setIdentifier("worker"); - worker_.connect("tcp://localhost:5555"); + Delegator delegator{ctx, settings}; - requester_.setIdentifier(); - requester_.connect(DELEGATOR_SOCKET_ADDR.c_str()); - } + Socket requester{ctx, zmq::socket_type::dealer, "requester"}; + requester.connect(settings.bindAddress); - ~DelegatorTest() + SECTION("responds to HELLO from worker with WELCOME") { - std::this_thread::sleep_for(std::chrono::milliseconds(100)); - running_ = false; - delFuture_.wait(); - } - - zmq::context_t context_; - Socket worker_; - Socket requester_; - bool running_; - std::future delFuture_; -}; + { + protocol::Hello hello; + hello.jobTypesRange = std::make_pair(1, 3); + hello.hbTimeoutSecs = 20; -TEST_F(DelegatorTest, canSendHelloToDelegator) -{ - worker_.send({ HELLO, { "0:1" }}); -} + REQUIRE(network.send({"", HELLO, serialise(hello)}) == true); + } -/* -TEST_F(DelegatorTest, canSendAndReceiveSingleJobTypeMultipleTimes) -{ - worker_.send({ HELLO, { "0:1" }}); + delegator.poll(); - // Send a job request - requester_.send({{ "42" }, REQUEST, { "0", "Request 1" }}); - auto job1 = receiveIgnoreHBs(worker_); - EXPECT_EQ(Message(JOB, { "0", "0", "Request 1" }), job1); + { + const auto msg = network.recv(); + REQUIRE(msg.subject == WELCOME); - // Send another job request - requester_.send({{ "36" }, REQUEST, { "0", "Request 2" }}); - auto job2 = receiveIgnoreHBs(worker_); - EXPECT_EQ(Message(JOB, { "0", "1", "Request 2" }), job2); -} + const auto welcome = protocol::unserialise(msg.data); + REQUIRE(welcome.hbTimeoutSecs == 20); + } -TEST_F(DelegatorTest, canSendAndReceiveMultipleJobTypes) -{ - worker_.send({ HELLO, { "0:2" }}); + SECTION("sends jobs to worker when BATCH JOB is received") + { + { + protocol::BatchJob batchJob; + batchJob.id = 1; + batchJob.data.push_back(1); + batchJob.data.push_back(2); + batchJob.data.push_back(3); - // Send a job request with two job types - requester_.send({{ "42" }, REQUEST, { "0:1", "Request" }}); + REQUIRE(requester.send({"", BATCH_JOB, serialise(batchJob)}) == true); + } - // Receive both of the requests - auto job1 = receiveIgnoreHBs(worker_); - auto job2 = receiveIgnoreHBs(worker_); + delegator.poll(); - ASSERT_EQ(3U, job1.data.size()); - ASSERT_EQ(3U, job2.data.size()); + { + std::vector jobs; + for (auto i = 0; i < settings.numJobTypes; i++) + { + const auto msg = network.recv(); + REQUIRE(msg.subject == JOB); + + jobs.push_back(protocol::unserialise(msg.data)); + } + + REQUIRE(jobs.size() == settings.numJobTypes); + + std::sort(jobs.begin(), jobs.end(), [](auto&& a, auto&& b) { return a.id < b.id; }); + + for (auto i = 0; i < settings.numJobTypes; i++) + { + REQUIRE(jobs[i].id == i + 1); + REQUIRE(jobs[i].data.size() == 3); + REQUIRE(jobs[i].data[0] == 1); + REQUIRE(jobs[i].data[1] == 2); + REQUIRE(jobs[i].data[2] == 3); + } + } - if (job1.data[0] == "0") - { - EXPECT_EQ(Message(JOB, { "0", "0", "Request" }), job1); - EXPECT_EQ(Message(JOB, { "1", "1", "Request" }), job2); - } - else - { - EXPECT_EQ(Message(JOB, { "1", "0", "Request" }), job1); - EXPECT_EQ(Message(JOB, { "0", "1", "Request" }), job2); + SECTION("sends BATCH RESULT when all the results have been collected") + { + for (std::size_t i = 0; i < settings.numJobTypes; i++) + { + protocol::Result result; + result.id = i + 1; + result.data = i; + + REQUIRE(network.send({"", RESULT, serialise(result)}) == true); + + // Got to poll once per result since it's from the same socket + delegator.poll(); + } + + { + const auto msg = requester.recv(); + REQUIRE(msg.subject == BATCH_RESULT); + + const auto batchResult = protocol::unserialise(msg.data); + REQUIRE(batchResult.id == 1); + REQUIRE(batchResult.data.size() == 3); + REQUIRE(batchResult.data[0] == 0.0); + REQUIRE(batchResult.data[1] == 1.0); + REQUIRE(batchResult.data[2] == 2.0); + } + } + } } } - -TEST_F(DelegatorTest, canReceiveResultForRequest) -{ - // Connect the worker - worker_.send({ HELLO, { "0:1" }}); - - // Send a job request - requester_.send({{ "42" }, REQUEST, { "0", "Request" }}); - auto job = receiveIgnoreHBs(worker_); - EXPECT_EQ(Message(JOB, { "0", "0", "Request" }), job); - - // Send the job result - worker_.send({RESULT, { "0", "Result" }}); - - // Get the job result from the requester - auto result = requester_.receive(); - EXPECT_EQ(Message({ "42" }, RESULT, { "Result" }), result); -} - -TEST_F(DelegatorTest, multipleHelloMessages) -{ - worker_.send({ HELLO, { "0:1" }}); - worker_.send({ HELLO, { "1:2" }}); // Should be ignored - worker_.send({ HELLO, { "2:3" }}); // Should be ignored -} - -TEST_F(DelegatorTest, requesterSendsBeforeWorkerSaysHello) -{ - // Send a job request first - requester_.send({{ "42" }, REQUEST, { "0", "Request 1" }}); - - // Worker connects - worker_.send({ HELLO, { "0:1" }}); - auto job = receiveIgnoreHBs(worker_); - EXPECT_EQ(Message(JOB, { "0", "0", "Request 1" }), job); -} - -TEST_F(DelegatorTest, resendsJobAfterWorkerFailure) -{ - // Send a job request - requester_.send({{ "42" }, REQUEST, { "0", "Request" }}); - - // Receive the job. This worker does not send heartbeats and will timeout eventually. - worker_.send({ HELLO, { "0:1" }}); - receiveIgnoreHBs(worker_); - - // Wait for this worker to time out - std::this_thread::sleep_for(std::chrono::milliseconds(1000)); - - // This new worker should get the job that was received by the dead worker. - Socket newWorker{context_, ZMQ_DEALER, "mockNewWorker", 0}; - newWorker.setIdentifier("newWorker"); - newWorker.connect("tcp://localhost:5555"); - - // Connect the new worker - newWorker.send({ HELLO, { "0:1" }}); - - // Wait for a job, this should unblock as soon as the heartbeat times out - // and the previous worker considered dead. - auto job = receiveIgnoreHBs(newWorker); - EXPECT_EQ(Message(JOB, { "0", "0", "Request" }), job); - - // Send the job result - newWorker.send({ RESULT, { "0", "Result" }}); - - // Get the job result from the requester - auto result = requester_.receive(); - EXPECT_EQ(Message({ "42" }, RESULT, { "Result" }), result); -} - -TEST_F(DelegatorTest, workerReceivesEverythingForEmptyJobTypes) -{ - worker_.send({ HELLO, { "" }}); - - // Send a job request - requester_.send({{ "42" }, REQUEST, { "3", "Request 1" }}); - auto job1 = receiveIgnoreHBs(worker_); - EXPECT_EQ(Message(JOB, { "3", "0", "Request 1" }), job1); - - // Send another job request - requester_.send({{ "36" }, REQUEST, { "5", "Request 2" }}); - auto job2 = receiveIgnoreHBs(worker_); - EXPECT_EQ(Message(JOB, { "5", "1", "Request 2" }), job2); - -}*/ From a82386447b7291d85925ce48757ab4e63f47f62a Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 15:01:29 +1000 Subject: [PATCH 06/28] Remove worker --- src/comms/settings.hpp | 54 -------------------------- src/comms/worker.cpp | 88 ------------------------------------------ src/comms/worker.hpp | 65 ------------------------------- 3 files changed, 207 deletions(-) delete mode 100644 src/comms/worker.cpp delete mode 100644 src/comms/worker.hpp diff --git a/src/comms/settings.hpp b/src/comms/settings.hpp index 120eaa1..266f6f2 100644 --- a/src/comms/settings.hpp +++ b/src/comms/settings.hpp @@ -17,38 +17,6 @@ namespace stateline { namespace comms { -//! Settings for controlling heartbeat threads. -//! -struct HeartbeatSettings -{ - //! The number of milliseconds between each heartbeat. - uint msRate; - - //! The rate at which the heartbeat sockets are polled. - int msPollRate; - - //! The heartbeat timeout in milliseconds. - uint msTimeout; - - static HeartbeatSettings WorkerDefault() - { - HeartbeatSettings settings; - settings.msRate = 1000; - settings.msPollRate = 500; - settings.msTimeout = 3000; - return settings; - } - - static HeartbeatSettings DelegatorDefault() - { - HeartbeatSettings settings; - settings.msRate = 1000; - settings.msPollRate = 500; - settings.msTimeout = 5000; - return settings; - } -}; - //! Settings to control the behaviour of delegators. //! struct DelegatorSettings @@ -76,28 +44,6 @@ struct DelegatorSettings } }; -//! Settings to control the behaviour of workers. -//! -struct WorkerSettings -{ - //! The address of the delegator to connect to. - std::string networkAddress; - - //! The address of this worker which the minion connects to. - std::string workerAddress; - - //! Settings for the heartbeat monitoring. - HeartbeatSettings heartbeat; - - //! Default delegator settings - WorkerSettings(std::string networkAddress, std::string workerAddress) - : networkAddress{std::move(networkAddress)} - , workerAddress{std::move(workerAddress)} - { - heartbeat = HeartbeatSettings::WorkerDefault(); - } -}; - //! Settings to control the behaviour of agents. //! struct AgentSettings diff --git a/src/comms/worker.cpp b/src/comms/worker.cpp deleted file mode 100644 index 99187d4..0000000 --- a/src/comms/worker.cpp +++ /dev/null @@ -1,88 +0,0 @@ -//! -//! Contains the implementation of the worker. -//! -//! \file comms/worker.cpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "comms/worker.hpp" -#include "comms/thread.hpp" - -#include -#include - -namespace stateline { namespace comms { - -Worker::Worker(zmq::context_t& ctx, const WorkerSettings& settings, bool& running) - : minion_{ctx, zmq::socket_type::dealer, "toMinion", NO_LINGER} - , network_{ctx, zmq::socket_type::dealer, "toNetwork", NO_LINGER} - , router_{"worker", std::tie(minion_, network_)} - , hbSettings_{settings.heartbeat} - , running_{running} - , minionWaiting_{true} -{ - // Initialise the local sockets - minion_.bind(settings.workerAddress); - network_.setIdentity(); - LOG(INFO) << "Worker connecting to " << settings.networkAddress; - network_.connect("tcp://" + settings.networkAddress); - - // Specify the Worker functionality - auto onJobFromNetwork = [&] (const Message& m) { - if (minionWaiting_) - { - minion_.send(m); - minionWaiting_ = false; - } - else - { - queue_.push(m); - } - }; - - auto onResultFromMinion = [&] (const Message & m) - { - network_.send(m); - if (queue_.size() > 0) - { - minion_.send(queue_.front()); - queue_.pop(); - } - else - { - minionWaiting_ = true; - } - }; - - auto forwardToHB = [&](const Message& m) { }; - auto forwardToNetwork = [&](const Message& m) { network_.send({{},m.subject, m.data}); }; - /*auto disconnect = [&](const Message&) - { - LOG(INFO)<< "Worker disconnecting from server"; - exit(EXIT_SUCCESS); - };*/ - - // Just the order we gave them to the router - const uint MINION_SOCKET = 0, NETWORK_SOCKET = 1; - - // Bind functionality to the router - router_.bind(onResultFromMinion); - router_.bind(forwardToNetwork); - router_.bind(onJobFromNetwork); - router_.bind(forwardToHB); - router_.bind(forwardToHB); - router_.bind(forwardToHB); - //router_.bindOnPoll(sendHeartbeat); -} - -void Worker::start() -{ - router_.poll(msPollRate_, running_); -} - -} - -} diff --git a/src/comms/worker.hpp b/src/comms/worker.hpp deleted file mode 100644 index bb299b7..0000000 --- a/src/comms/worker.hpp +++ /dev/null @@ -1,65 +0,0 @@ -//! -//! The worker object connects with a delegator, then forwards job requests -//! to a set of minions that actually perform the work. These minions then -//! return the worker results, which are forwarded back to the delegator. -//! -//! \file comms/worker.hpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include -#include - -#include - -#include "settings.hpp" -#include "datatypes.hpp" -#include "router.hpp" -#include "socket.hpp" - -namespace stateline -{ - -namespace comms -{ - -//! Worker object that takes jobs, forwards them to a minion -//! then receives results from the minion and send them back -//! to the delegator. -//! -class Worker -{ -public: - //! Construct a new worker that can handle multiple types of jobs. - //! - //! \param settings The configuration object. - //! - Worker(zmq::context_t& ctx, const WorkerSettings& settings, bool& running); - - // Workers can't be copied. - Worker(const Worker &) = delete; - - void start(); - -private: - Socket minion_; - Socket network_; - Router router_; - - uint msPollRate_; - HeartbeatSettings hbSettings_; - - bool& running_; - - std::queue queue_; - bool minionWaiting_; -}; - -} // namespace comms - -} // namespace stateline From 19bd39e4cb505f25c134329057e3514613c0b698 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 15:14:35 +1000 Subject: [PATCH 07/28] Building again --- CMakeLists.txt | 2 +- src/app/CMakeLists.txt | 2 +- src/bin/CMakeLists.txt | 10 +++----- src/bin/agent.cpp | 58 ++++++++++++++++++++++++++++++++++++++++++ src/infer/sampler.cpp | 8 +++--- src/infer/sampler.hpp | 3 --- 6 files changed, 68 insertions(+), 15 deletions(-) create mode 100644 src/bin/agent.cpp diff --git a/CMakeLists.txt b/CMakeLists.txt index 6577eb5..8e1bb0e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -135,7 +135,7 @@ ADD_SUBPROJECT(src/bin) # Build final libraries for server and client ############################################################################## ADD_LIBRARY(statelineserver STATIC #SHARED - $ $ + $ #$ $ $ $ $) diff --git a/src/app/CMakeLists.txt b/src/app/CMakeLists.txt index f055487..2f7bc3b 100644 --- a/src/app/CMakeLists.txt +++ b/src/app/CMakeLists.txt @@ -6,4 +6,4 @@ # Date: 2014 ADD_LIBRARY(commonwrapper OBJECT logging.cpp signal.cpp) -ADD_LIBRARY(serverwrapper OBJECT serverwrapper.cpp api.cpp) +#ADD_LIBRARY(serverwrapper OBJECT serverwrapper.cpp api.cpp) diff --git a/src/bin/CMakeLists.txt b/src/bin/CMakeLists.txt index 0b50a7d..d2a46fa 100644 --- a/src/bin/CMakeLists.txt +++ b/src/bin/CMakeLists.txt @@ -12,10 +12,7 @@ FUNCTION(ADD_BINARY name library) SET_TARGET_PROPERTIES(${name} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${STATELINE_BINARY_DIR}) - TARGET_LINK_LIBRARIES(${name} - ${library} - ${Boost_SYSTEM_LIBRARY} - ${Boost_PROGRAM_OPTIONS_LIBRARY}) + TARGET_LINK_LIBRARIES(${name} ${library}) INSTALL (TARGETS ${name} RUNTIME DESTINATION bin) ENDFUNCTION() @@ -28,5 +25,6 @@ ENDFUNCTION() # no point building this until we have a need for it #ADD_BINARY(stateline-server statelineserver) -ADD_BINARY(stateline-client statelineclient) -ADD_BINARY(stateline statelineserver) +#ADD_BINARY(stateline-client statelineclient) +#ADD_BINARY(stateline statelineserver) +ADD_BINARY(agent statelineclient) diff --git a/src/bin/agent.cpp b/src/bin/agent.cpp new file mode 100644 index 0000000..8881adf --- /dev/null +++ b/src/bin/agent.cpp @@ -0,0 +1,58 @@ +//! Process that runs the Stateline agent +//! +//! \file src/bin/agent.cpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2014 +//! \licence Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! + +#include +#include +#include + +#include "ezoptionparser/ezOptionParser.hpp" + +#include "app/logging.hpp" +#include "app/commandline.hpp" +#include "comms/agent.hpp" + +namespace sl = stateline; + +ez::ezOptionParser commandLineOptions() +{ + ez::ezOptionParser opt; + opt.overview = "Stateline agent options"; + opt.add("", 0, 0, 0, "Print help message", "-h", "--help"); + opt.add("0", 0, 1, 0, "Logging level", "-l", "--log-level"); + opt.add("localhost:5555", 0, 1, 0, "Address of delegator", "-n", "--network-addr"); + opt.add("ipc:///tmp/sl_agent.sock", 0, 1, 0, "Address of agent for worker to connect to", "-a", "--agent-addr"); + return opt; +} + +int main(int argc, const char *argv[]) +{ + // Parse the command line + auto opt = commandLineOptions(); + opt.parse(argc, argv); + + // Initialise logging + int logLevel; + opt.get("-l")->getInt(logLevel); + sl::initLogging(logLevel); + + // Initialise the agent + std::string networkAddr, bindAddr; + opt.get("-a")->getString(bindAddr); + opt.get("-n")->getString(networkAddr); + sl::comms::AgentSettings settings{bindAddr, networkAddr}; + + zmq::context_t ctx{1}; + sl::comms::Agent agent{ctx, settings}; + + bool running = true; + agent.start(running); + + return 0; +} diff --git a/src/infer/sampler.cpp b/src/infer/sampler.cpp index 45866d8..27f501e 100644 --- a/src/infer/sampler.cpp +++ b/src/infer/sampler.cpp @@ -104,14 +104,12 @@ namespace stateline //ProposalFunction& proposal, Sampler::Sampler(comms::Requester& requester, - std::vector jobTypes, ChainArray& chainArray, mcmc::GaussianProposal& proposal, RegressionAdapter& sigmaAdapter, RegressionAdapter& betaAdapter, uint swapInterval) : requester_(requester), - jobTypes_(std::move(jobTypes)), chains_(chainArray), proposal_(proposal), sigmaAdapter_(sigmaAdapter), @@ -207,8 +205,10 @@ namespace stateline { // todo(Al) - should we be getting this from the chains directly? double sigma = sigmaAdapter_.values()[id]; - propStates_[id] = proposal_(id, chains_.lastState(id).sample, sigma); - requester_.submit(id, jobTypes_, propStates_[id]); + const auto prop = proposal_(id, chains_.lastState(id).sample, sigma); + std::vector data(prop.data(), prop.data() + prop.size()); + requester_.submit(id, data); + propStates_[id] = prop; numOutstandingJobs_++; } diff --git a/src/infer/sampler.hpp b/src/infer/sampler.hpp index c97f877..b3348b5 100644 --- a/src/infer/sampler.hpp +++ b/src/infer/sampler.hpp @@ -89,7 +89,6 @@ namespace stateline public: // look into ProposalFunction& proposal Sampler(comms::Requester& requester, - std::vector jobTypes, ChainArray& chainArray, mcmc::GaussianProposal& proposal, RegressionAdapter& sigmaAdapter, @@ -110,8 +109,6 @@ namespace stateline comms::Requester& requester_; - std::vector jobTypes_; - // The MCMC chain wrapper ChainArray& chains_; From 572033547256c656ce905fc637e3c5f6943a06ae Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 15:15:48 +1000 Subject: [PATCH 08/28] Remove protobuf --- CMakeLists.txt | 7 +------ proto/CMakeLists.txt | 3 --- proto/messages.proto | 35 ----------------------------------- src/comms/protobuf.hpp | 23 ----------------------- src/test/worker.cpp | 35 ----------------------------------- 5 files changed, 1 insertion(+), 102 deletions(-) delete mode 100644 proto/CMakeLists.txt delete mode 100644 proto/messages.proto delete mode 100644 src/comms/protobuf.hpp delete mode 100644 src/test/worker.cpp diff --git a/CMakeLists.txt b/CMakeLists.txt index 8e1bb0e..d0b65ed 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -78,15 +78,11 @@ FIND_PACKAGE(ZMQ REQUIRED) # Eigen FIND_PACKAGE(Eigen3 3.2.0 REQUIRED) -# Protobuf -FIND_PACKAGE(Protobuf REQUIRED) - ############################################################################## # INCLUDE DIRECTORIES ############################################################################## INCLUDE_DIRECTORIES("${STATELINE_SOURCE_DIR}/src" - SYSTEM "${PROTOBUF_INCLUDE_DIR}" SYSTEM "${CMAKE_CURRENT_BINARY_DIR}" SYSTEM "${STATELINE_SOURCE_DIR}/external" SYSTEM "${STATELINE_SOURCE_DIR}/external/cppzmq" @@ -95,7 +91,6 @@ INCLUDE_DIRECTORIES("${STATELINE_SOURCE_DIR}/src" SYSTEM "${ZMQ_INCLUDE_DIR}" SYSTEM "${EIGEN3_INCLUDE_DIR}") -ADD_SUBDIRECTORY(proto) ADD_SUBDIRECTORY(src/test) ############################################################################## @@ -145,7 +140,7 @@ SET_TARGET_PROPERTIES(statelineserver PROPERTIES LINKER_LANGUAGE CXX) ADD_LIBRARY(stateline-server STATIC $ $ $) -TARGET_LINK_LIBRARIES(stateline-server proto ${ZMQ_LIBRARY} ${PROTOBUF_LIBRARY}) +TARGET_LINK_LIBRARIES(stateline-server ${ZMQ_LIBRARY}) ADD_LIBRARY(statelineclient STATIC #SHARED $ diff --git a/proto/CMakeLists.txt b/proto/CMakeLists.txt deleted file mode 100644 index d5bd08b..0000000 --- a/proto/CMakeLists.txt +++ /dev/null @@ -1,3 +0,0 @@ -INCLUDE_DIRECTORIES(${PROTOBUF_INCLUDE_DIR}) -PROTOBUF_GENERATE_CPP(PROTO_SRC PROTO_HEADER messages.proto) -ADD_LIBRARY(proto ${PROTO_HEADER} ${PROTO_SRC}) diff --git a/proto/messages.proto b/proto/messages.proto deleted file mode 100644 index c96cb54..0000000 --- a/proto/messages.proto +++ /dev/null @@ -1,35 +0,0 @@ -package messages; - -message Heartbeat { - // Empty message -} - -message Hello { - optional uint32 hb_timeout_secs = 1; -} - -message Welcome { - optional uint32 hb_timeout_secs = 1; -} - -message Job { - required uint32 id = 1; // Job ID - optional uint32 job_type = 2; // Job type - repeated double data = 3 [packed=true]; // Job data -} - -message Result { - required uint32 id = 1; // Job ID - optional double data = 2; // Result data -} - -message BatchJob { - required uint32 id = 1; // Batch ID - repeated uint32 job_type = 2; // Job types this request uses - repeated double data = 3 [packed=true]; // Job data -} - -message BatchResult { - required uint32 id = 1; // Batch ID - repeated double data = 2 [packed=true]; // Result data -} diff --git a/src/comms/protobuf.hpp b/src/comms/protobuf.hpp deleted file mode 100644 index d632c2c..0000000 --- a/src/comms/protobuf.hpp +++ /dev/null @@ -1,23 +0,0 @@ -#pragma once - -#include - -namespace stateline { namespace comms { - -template -std::string protobufToString(const Protobuf& protobuf) -{ - std::string buf; - protobuf.SerializeToString(&buf); - return buf; -} - -template -Protobuf stringToProtobuf(const std::string& str) -{ - Protobuf protobuf; - protobuf.ParseFromString(str); - return protobuf; -} - -} } diff --git a/src/test/worker.cpp b/src/test/worker.cpp deleted file mode 100644 index 952882a..0000000 --- a/src/test/worker.cpp +++ /dev/null @@ -1,35 +0,0 @@ -//! Tests for worker. -//! -//! \file comms/tests/worker.cpp -//! \author Darren Shen -//! \date 2016 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "catch/catch.hpp" - -#include "comms/worker.hpp" -#include "comms/protobuf.hpp" - -using namespace stateline::comms; - -constexpr const char* DELEGATOR_ADDR = "tcp://*:5000"; - -WorkerSettings workerSettings() -{ - WorkerSettings settings; - settings.networkAddress = DELEGATOR_ADDR; - - return settings; -} - -TEST_CASE("Can connect to delegator and worker", "[worker]") -{ - zmq::context_t ctx{1}; - - Socket delegator{ctx, zmq::socket_type::router, "toRequester"}; - delegator.bind(DELEGATOR_ADDR); - - Worker worker{ctx, settings}; -} From 15eb0e5de09eff1ed2b2c93c918bf2bf33b04cd5 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 15:24:53 +1000 Subject: [PATCH 09/28] Coaxing Travis CI --- src/comms/heartbeat.hpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/comms/heartbeat.hpp b/src/comms/heartbeat.hpp index 1b97dbd..4af47dd 100644 --- a/src/comms/heartbeat.hpp +++ b/src/comms/heartbeat.hpp @@ -14,6 +14,7 @@ #include "comms/settings.hpp" #include +#include #include namespace stateline { namespace comms { From ba45af4a84d654f22ef44985148fdf4d46d24990 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 15:27:26 +1000 Subject: [PATCH 10/28] Remove unused files --- src/bin/stateline-client.cpp | 85 ------------------ src/comms/MESSAGES.SPEC | 6 -- src/comms/serverheartbeat.cpp | 157 ---------------------------------- src/comms/serverheartbeat.hpp | 69 --------------- src/comms/thread.hpp | 35 -------- 5 files changed, 352 deletions(-) delete mode 100644 src/bin/stateline-client.cpp delete mode 100644 src/comms/MESSAGES.SPEC delete mode 100644 src/comms/serverheartbeat.cpp delete mode 100644 src/comms/serverheartbeat.hpp delete mode 100644 src/comms/thread.hpp diff --git a/src/bin/stateline-client.cpp b/src/bin/stateline-client.cpp deleted file mode 100644 index 98aa648..0000000 --- a/src/bin/stateline-client.cpp +++ /dev/null @@ -1,85 +0,0 @@ -//! -//! A demo using Stateline to sample from a Gaussian mixture. -//! -//! This file aims to be a tutorial on setting up a MCMC simulation using -//! the C++ worker API of Stateline. -//! -//! \file demoWorker.cpp -//! \author Lachlan McCalman -//! \author Darren Shen -//! \date 2014 -//! \licence Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include -#include -#include - -#include -#include -#include "ezoptionparser/ezOptionParser.hpp" - -#include "../app/logging.hpp" -#include "../app/commandline.hpp" -#include "../comms/worker.hpp" -#include "../app/signal.hpp" -#include "../comms/thread.hpp" - -namespace sl = stateline; -namespace ph = std::placeholders; -namespace ch = std::chrono; - -ez::ezOptionParser commandLineOptions() -{ - ez::ezOptionParser opt; - opt.overview = "Stateline client worker options"; - opt.add("", 0, 0, 0, "Print help message", "-h", "--help"); - opt.add("0", 0, 1, 0, "Logging level", "-l", "--log-level"); - opt.add("localhost:5555", 0, 1, 0, "Address of delegator", "-n", "--network-addr"); - opt.add("ipc:///tmp/sl_worker.sock", 0, 1, 0, "Address of worker for minion to connect to", "-w", "--worker-addr"); - return opt; -} - -int main(int argc, const char *argv[]) -{ - // Parse the command line - auto opt = commandLineOptions(); - opt.parse(argc, argv); - - // Initialise logging - int logLevel; - opt.get("-l")->getInt(logLevel); - sl::initLogging(logLevel); - - // Capture Ctrl+C - sl::init::initialiseSignalHandler(); - - // -------------------------------------------------------------------------- - // Initialise the worker - // -------------------------------------------------------------------------- - std::string networkAddr, workerAddr; - opt.get("-n")->getString(networkAddr); - opt.get("-w")->getString(workerAddr); - sl::comms::WorkerSettings settings = sl::comms::WorkerSettings::Default(networkAddr, workerAddr); - - // In Stateline, a worker can handle multiple job types. Since the server - // only sends out one job type, we can just set it to the default job type - // of 0. In cases where there are more than one job type, the vector should - // contain the job types that this worker wants to handle. - zmq::context_t* context = new zmq::context_t(1); - bool running = true; - auto future = sl::startInThread(running, std::ref(*context), std::cref(settings)); - - while(!sl::global::interruptedBySignal) - { - std::this_thread::sleep_for(ch::milliseconds(500)); - } - - running = false; - delete context; - - future.wait(); - - return 0; -} diff --git a/src/comms/MESSAGES.SPEC b/src/comms/MESSAGES.SPEC deleted file mode 100644 index 5b7d29d..0000000 --- a/src/comms/MESSAGES.SPEC +++ /dev/null @@ -1,6 +0,0 @@ - -# HELLO: ["", '0', "jobtype1:jobtype2"] -# HEARTBEAT : ["worker-socket-identity", "", '1'] -# REQUEST : ["requester_socket_identity", "batchID", "", '2', "jobtype1:jobtype2", "myjobdata"] -# JOB : ["", '3', "jobtype1", "uniqueID", "myjobdata"] -# RESULT : ["", '4', "uniqueID', "myresultdata"] diff --git a/src/comms/serverheartbeat.cpp b/src/comms/serverheartbeat.cpp deleted file mode 100644 index a921486..0000000 --- a/src/comms/serverheartbeat.cpp +++ /dev/null @@ -1,157 +0,0 @@ -//! -//! Implementation of heartbeat routers that deal with server heartbeating sending and receiving. -//! -//! \file comms/serverheartbeat.cpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include "comms/serverheartbeat.hpp" -#include -#include - -namespace stateline -{ - namespace comms - { - //! Add a new client to be monitored for heartbeating. - //! - //! \param m The HELLO message from the client. - //! \param clients List of clients being monitored. - //! \param lastHeartbeats Map containing when the last heartbeat arrived from each client. - //! - void insertClient(const Message& m, HBClients& clients, HBMap& lastHeartbeats); - - //! Remove a client from being monitored for heartbeating. - //! - //! \param m The GOODBYE message from the client. - //! \param clients List of clients being monitored. - //! \param lastHeartbeats Map containing when the last heartbeat arrived from each client. - //! - void deleteClient(const Message& m, HBClients& clients, HBMap& lastHeartbeats); - - //! Update book-keeping on client heartbeats. Called when a heartbeat message arrives - //! from a client. - //! - //! \param m The HEARTBEAT message from the client. - //! \param lastHeartbeats Map containing when the last heartbeat arrived from each client. - //! - void receiveHeartbeat(const Message& m, HBMap& lastHeartbeats); - - //! Update book-keeping on client heartbeats. Called every time the socket is polled. - //! - //! \param clients List of clients being monitored. - //! \param lastHeartbeats Map containing when the last heartbeat arrived from each client. - //! \param router A reference to the socket router. - //! \param msTimeout The heartbeat timeout in milliseconds. - //! - void monitorTimeouts(HBClients& clients, HBMap& lastHeartbeats, Socket& socket, uint msTimeout); - - //! Send heartbeats to all the clients if necessary. - //! - //! \param clients List of clients being monitored. - //! \param lastHbTime The last time this thread sent out heartbeats. - //! \param router A reference to the socket router. - //! \param msFrequency The number of milliseconds between each heartbeat. - //! - void sendHeartbeats(HBClients& clients, hrc::time_point& lastHbTime, Socket& socket, uint msFrequency); - - ServerHeartbeat::ServerHeartbeat(zmq::context_t& context, const HeartbeatSettings& settings, bool& running) - : socket_(context, ZMQ_PAIR, "toServer"), - router_("HB", { &socket_ }), - msPollRate_(settings.msPollRate), - running_(running) - { - socket_.connect(SERVER_HB_SOCKET_ADDR); - - // Specify functionality - auto rcvHello = [&](const Message& m) { insertClient(m, clients_, lastHeartbeats_); }; - auto rcvGoodbye = [&](const Message& m) { deleteClient(m, clients_, lastHeartbeats_); }; - auto rcvHeartbeat = [&](const Message& m) { receiveHeartbeat(m, lastHeartbeats_); }; - - auto onPoll = [&]() - { - monitorTimeouts(clients_, lastHeartbeats_, socket_, settings.msTimeout); - sendHeartbeats(clients_, lastSendTime_, socket_, settings.msRate); - }; - - // Bind to router - const uint CLIENT_SOCKET = 0; - - router_.bind(CLIENT_SOCKET, HELLO, rcvHello); - router_.bind(CLIENT_SOCKET, GOODBYE, rcvGoodbye); - router_.bind(CLIENT_SOCKET, HEARTBEAT, rcvHeartbeat); - router_.bindOnPoll(onPoll); - } - - void ServerHeartbeat::start() - { - lastSendTime_ = std::chrono::high_resolution_clock::now(); - router_.poll(msPollRate_, running_); - } - - ServerHeartbeat::~ServerHeartbeat() - { - } - - void insertClient(const Message& m, HBClients& clients, HBMap& lastHeartbeats) - { - VLOG(1) << "HB system adding new client"; - clients.insert(m.address.back()); - lastHeartbeats.insert(std::pair(m.address.back(), hrc::now())); - VLOG(1) << "HB system added " << m.address.back(); - } - - void deleteClient(const Message& m, HBClients& clients, HBMap& lastHeartbeats) - { - VLOG(1) << " HB system received GOODBYE from " << m.address.back(); - clients.erase(clients.find(m.address.back())); - lastHeartbeats.erase(m.address.back()); - } - - void receiveHeartbeat(const Message& m, HBMap& lastHeartbeats) - { - auto deltaT = hrc::now() - lastHeartbeats[m.address.back()]; - uint deltams = std::chrono::duration_cast < std::chrono::milliseconds > (deltaT).count(); - VLOG(4) << "Heartbeat from " << m.address.back() << " with delta T = " << deltams << "ms"; - lastHeartbeats[m.address.back()] = hrc::now(); - } - - void monitorTimeouts(HBClients& clients, HBMap& lastHeartbeats, Socket& socket, uint msTimeout) - { - std::vector toRemove; - for (const auto& addr : clients) - { - auto msElapsed = std::chrono::duration_cast < std::chrono::milliseconds > (hrc::now() - lastHeartbeats[addr]).count(); - if (msElapsed > msTimeout) - { - VLOG(1) << "Heartbeat system sending GOODBYE on behalf of " << addr; - socket.send({{ addr }, GOODBYE}); - lastHeartbeats.erase(addr); - toRemove.push_back(addr); - } - } - - for (const auto& addr : toRemove) - clients.erase(addr); - } - - void sendHeartbeats(HBClients& clients, hrc::time_point& lastHbTime, Socket& socket, uint msFrequency) - { - auto currentTime = hrc::now(); - auto timeSinceLastHb = std::chrono::duration_cast(currentTime - lastHbTime); - if (timeSinceLastHb >= std::chrono::milliseconds(msFrequency)) - { - for (const auto& addr : clients) - { - VLOG(4) << "Sending HEARTBEAT to " << addr; - socket.send({{ addr }, HEARTBEAT}); - lastHbTime = hrc::now(); - } - } - } - - } // namespace comms -} // namespace stateline diff --git a/src/comms/serverheartbeat.hpp b/src/comms/serverheartbeat.hpp deleted file mode 100644 index 2b2939b..0000000 --- a/src/comms/serverheartbeat.hpp +++ /dev/null @@ -1,69 +0,0 @@ -//! -//! Heartbeat routers that deal with server heartbeating sending and receiving. -//! -//! \file comms/serverheartbeat.hpp -//! \author Lachlan McCalman -//! \date 2014 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#pragma once - -#include -#include - -#include "messages.hpp" -#include "router.hpp" -#include "settings.hpp" -#include "socket.hpp" - -namespace stateline -{ - namespace comms - { - //! Heartbeat sockets talk on these addresses. - const std::string SERVER_HB_SOCKET_ADDR = "inproc://serverhb"; - - //! A set of clients being monitored for heartbeating. - typedef std::set HBClients; - - //! A map of clients to when the last heartbeat arrived from that client. - typedef std::map HBMap; - - //! Handles heartbeating on the server side. Server heartbeat assumes that - //! it has multiple connections from different clients, so sends to all - //! of them, and keeps track of who is connected. - //! - class ServerHeartbeat - { - public: - //! Create a new server heartbeat thread. - //! - //! \param context The ZMQ context. - //! \param settings Heartbeat settings. - //! - ServerHeartbeat(zmq::context_t& context, const HeartbeatSettings& settings, bool& running); - - void start(); - - //! Cleanup resources used by the heartbeat thread. - //! - ~ServerHeartbeat(); - - private: - Socket socket_; - Router router_; - - uint msPollRate_; - - HBClients clients_; - HBMap lastHeartbeats_; - - hrc::time_point lastSendTime_; - - bool& running_; - }; - - } // namespace comms -} // namespace stateline diff --git a/src/comms/thread.hpp b/src/comms/thread.hpp deleted file mode 100644 index d2dd25b..0000000 --- a/src/comms/thread.hpp +++ /dev/null @@ -1,35 +0,0 @@ -#pragma once - -#include - -// Notes, this might have be be done on a per-type basis because the args -// don't line up. Otherwise I may have to restict what args the delegator, -// worker, and heartbeat systems all take. - -namespace stateline -{ - template - std::future startInThread(bool& running, Args&&... args) - { - auto func = [&running](Args&&... args) -> bool - { - try - { - T obj(std::forward(args)..., std::ref(running)); - obj.start(); - } - catch (const zmq::error_t& ex) - { - // Ignore ZMQ errors to prevent ugly stack trace - LOG(INFO) << "Caught interrupt. Goodbye!"; - } - catch (const std::exception& ex) - { - LOG(FATAL) << "Exception thrown in child thread: " << ex.what(); - } - return true; - }; - - return std::async(std::launch::async, func, std::forward(args)...); - } -} From fe5788411693343982a2d9d28015d946effff7f7 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 16:06:05 +1000 Subject: [PATCH 11/28] Agent does proper hellos --- src/comms/agent.cpp | 4 +--- src/comms/requester.cpp | 2 +- src/test/agent.cpp | 11 ++++++++++- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/src/comms/agent.cpp b/src/comms/agent.cpp index 1787399..94e8dfd 100644 --- a/src/comms/agent.cpp +++ b/src/comms/agent.cpp @@ -41,9 +41,7 @@ struct Agent::WorkerEndpoint : Endpoint void onHello(const Message& m) { - protocol::Hello hello; - hello.hbTimeoutSecs = timeout.count(); - agent.network.send({"", HELLO, serialise(hello)}); + agent.network.send(m); // Forward to delegator } void onResult(const Message& m) diff --git a/src/comms/requester.cpp b/src/comms/requester.cpp index ae62296..5bb72e4 100644 --- a/src/comms/requester.cpp +++ b/src/comms/requester.cpp @@ -29,7 +29,7 @@ void Requester::submit(BatchID id, const std::vector& data) socket_.send({"", BATCH_JOB, serialise(batchJob)}); } -std::pair> Requester::retrieve() +std::pair> Requester::retrieve() { const auto msg = socket_.recv(); const auto batchResult = protocol::unserialise(msg.data); diff --git a/src/test/agent.cpp b/src/test/agent.cpp index 57ce5ba..0c24396 100644 --- a/src/test/agent.cpp +++ b/src/test/agent.cpp @@ -34,7 +34,14 @@ TEST_CASE("agent can connect to network and worker", "[agent]") SECTION("forwards HELLO from worker to network") { - REQUIRE(worker.send({ "", HELLO, "" }) == true); // TODO + { + protocol::Hello hello; + hello.jobTypesRange = std::make_pair(1, 3); + hello.hbTimeoutSecs = 10; + + REQUIRE(worker.send({"", HELLO, serialise(hello)}) == true); + } + agent.poll(); std::string agentAddress; @@ -44,6 +51,8 @@ TEST_CASE("agent can connect to network and worker", "[agent]") REQUIRE(msg.subject == HELLO); const auto hello = protocol::unserialise(msg.data); + REQUIRE(hello.jobTypesRange.first == 1); + REQUIRE(hello.jobTypesRange.second == 3); REQUIRE(hello.hbTimeoutSecs == 10); } From 6080cd997d50a82dc2690a5c78ff54e8c46a0ef6 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 16:41:03 +1000 Subject: [PATCH 12/28] Better router --- src/common/meta.hpp | 61 ++++++++++++++++++++++---------------------- src/comms/router.hpp | 60 ++++++++++++++++++++----------------------- src/test/router.cpp | 12 --------- 3 files changed, 58 insertions(+), 75 deletions(-) diff --git a/src/common/meta.hpp b/src/common/meta.hpp index e3f688e..1d271b2 100644 --- a/src/common/meta.hpp +++ b/src/common/meta.hpp @@ -17,53 +17,52 @@ namespace stateline { namespace meta { -template struct seq {}; -template struct gen_seq : gen_seq {}; -template struct gen_seq<0, Is...> : seq {}; +namespace detail { -// Inspired by http://stackoverflow.com/questions/21062864/optimal-way-to-access-stdtuple-element-in-runtime-by-index - -namespace detail +template +constexpr auto makeArray(T head, Tail... tail) -> std::array { - template - Ret apply_one(T& p, F func) { return func(std::get(p)); } - - template - Ret apply(T& p, int index, F func, seq) - { - using FT = Ret(T&, F); - static constexpr FT* ftable[] = { &apply_one... }; - - assert(index < sizeof...(Is)); - return ftable[index](p, func); - } + return { { head, tail... } }; } -template -Ret apply(T& p, std::size_t index, F func) +template +void applyAllImpl(T&& t, F func, std::index_sequence) { - return detail::apply(p, index, func, gen_seq::value>{}); + int l[] = { (func(std::get(t)), 0)... }; + (void)l; } -// From http://stackoverflow.com/questions/16387354/template-tuple-calling-a-function-on-each-element -namespace detail +template +void enumerateAllImpl(T&& t, F func, std::index_sequence) { + int l[] = { (func(Is, std::get(t)), 0)... }; + (void)l; +} -template -void apply_all_impl(T&& t, F func, seq) +template +constexpr decltype(auto) mapAllImpl(T&& t, F func, std::index_sequence) { - std::initializer_list l = { (func(std::get(t)), 0)... }; - (void)l; + return makeArray(func(std::get(t))...); } +} // namespace detail + +template +void applyAll(const std::tuple& t, F func) +{ + detail::applyAllImpl(t, func, std::index_sequence_for{}); } template -void apply_all(const std::tuple& t, F func) +void enumerateAll(std::tuple& t, F func) { - detail::apply_all_impl(t, func, gen_seq()); + detail::enumerateAllImpl(t, func, std::index_sequence_for{}); } -} // namespace meta +template +constexpr decltype(auto) mapAll(const std::tuple& t, F func) +{ + return detail::mapAllImpl(t, func, std::index_sequence_for{}); +} -} // namespace stateline +} } // namespace stateline diff --git a/src/comms/router.hpp b/src/comms/router.hpp index e15187c..d5d6d33 100644 --- a/src/comms/router.hpp +++ b/src/comms/router.hpp @@ -42,58 +42,54 @@ template class Router { public: + static_assert(sizeof...(Endpoints) > 0, "Must have at least one endpoint"); + //! Create a new router. //! Router(std::string name, const std::tuple& endpoints) : name_{std::move(name)} , endpoints_{endpoints} + , sockets_{meta::mapAll(endpoints, [](auto& e) { return static_cast(&e.socket()); })} + , pollList_{meta::mapAll(endpoints, [](auto &e) { return zmq::pollitem_t{(void *)e.socket().zmqSocket(), 0, ZMQ_POLLIN, 0}; })} { - pollList_.reserve(sizeof...(Endpoints)); - sockets_.reserve(sizeof...(Endpoints)); - - meta::apply_all(endpoints, [&pollList = pollList_, &sockets = sockets_](auto& e) - { - // Need to cast a socket_t into (void *) - pollList.push_back({(void *)e.socket().zmqSocket(), 0, ZMQ_POLLIN, 0}); - sockets.push_back(static_cast(&e.socket())); - }); } - template - void poll(const IdleCallback& callback) + int pollWaitTime() { - // Figure out how long we can wait for before any SocketBase times out const auto it = std::min_element(sockets_.begin(), sockets_.end(), detail::compSocketTimeouts); - if (it != sockets_.end()) + if ((*it)->heartbeats().hasTimeout()) { - if ((*it)->heartbeats().hasTimeout()) - { - const auto wait = std::chrono::duration_cast( - (*it)->heartbeats().nextTimeout() - Heartbeat::Clock::now()); + const auto wait = std::chrono::duration_cast( + (*it)->heartbeats().nextTimeout() - Heartbeat::Clock::now()); - zmq::poll(pollList_, std::max(wait, std::chrono::milliseconds{0})); - } - else - { - // Poll indefinitely - zmq::poll(pollList_); - } + return std::max(wait, std::chrono::milliseconds{0}).count(); // 0 for return immediately if we have to heartbeat } + else + { + // Poll indefinitely + return -1; + } + } + + template + void poll(const IdleCallback& callback) + { + zmq::poll(pollList_.data(), pollList_.size(), pollWaitTime()); // Handle each poll event - for (std::size_t i = 0; i < pollList_.size(); i++) + meta::enumerateAll(endpoints_, [&pollList = pollList_](const auto i, auto& endpoint) { - bool newMsg = pollList_[i].revents & ZMQ_POLLIN; + bool newMsg = pollList[i].revents & ZMQ_POLLIN; if (newMsg) { - LOG(INFO) << "Router " << name_ << " received new message from endpoint " - << meta::apply(endpoints_, i, [](auto& m) { return m.socket().name(); }); + //TODO LOG(INFO) << "Router " << name_ << " received new message from endpoint " + //<< endpoint.socket().name(); - meta::apply(endpoints_, i, [](auto& e) { return e.accept(); }); + endpoint.accept(); } - } + }); callback(); } @@ -101,8 +97,8 @@ class Router private: std::string name_; std::tuple endpoints_; - std::vector sockets_; // TODO: make this into array - std::vector pollList_; + std::array sockets_; + std::array pollList_; }; } } diff --git a/src/test/router.cpp b/src/test/router.cpp index 7785e1b..5b3aff6 100644 --- a/src/test/router.cpp +++ b/src/test/router.cpp @@ -31,18 +31,6 @@ struct TestEndpoint : Endpoint } -TEST_CASE("can poll a router with no sockets", "[router]") -{ - zmq::context_t ctx{1}; - - Router<> router{"test_router", std::tie()}; - - bool idleCalled = false; - router.poll([&idleCalled]() { idleCalled = true; }); - - REQUIRE(idleCalled == true); -} - TEST_CASE("router poll calls the correct callbacks", "[router]") { zmq::context_t ctx{1}; From 113069190e36dd6a6824a732e680c98bdfb57bbb Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 22:33:46 +1000 Subject: [PATCH 13/28] Better binary packing --- src/comms/binary.hpp | 67 ++++++++++++++-------- src/comms/protocol.hpp | 125 ++++++++++++----------------------------- src/test/binary.cpp | 17 ++++-- 3 files changed, 92 insertions(+), 117 deletions(-) diff --git a/src/comms/binary.hpp b/src/comms/binary.hpp index 75a3c1e..45d2cc4 100644 --- a/src/comms/binary.hpp +++ b/src/comms/binary.hpp @@ -15,30 +15,55 @@ namespace stateline { namespace comms { -template -void packValue(std::string& buf, const T& val) +class Packer { - buf.append(reinterpret_cast(&val), sizeof(T)); -} +public: + explicit Packer(std::string& buf) + : buf{buf} + { + } -template -void packRange(std::string& buf, const T *first, const T *last) -{ - buf.append(reinterpret_cast(first), (last - first) * sizeof(T)); -} + void reserve(std::size_t capacity) + { + buf.reserve(capacity); + } -struct Unpacker -{ - const char *first; - const char *last; + template + void value(const T& val) + { + assert(buf.size() + sizeof(T) <= buf.capacity()); + buf.append(reinterpret_cast(&val), sizeof(T)); + } + template + void rawRange(Container& container) + { + using T = typename Container::value_type; + const auto first = container.data(); + const auto last = container.data() + container.size(); + assert(buf.size() + (last - first) * sizeof(T) <= buf.capacity()); + buf.append(reinterpret_cast(first), (last - first) * sizeof(T)); + } + +private: + std::string& buf; +}; + +class Unpacker +{ +public: explicit Unpacker(const std::string& buf) : first{buf.data()}, last{buf.data() + buf.size()} { } + void reserve(std::size_t capacity) + { + // Does nothing + } + template - void unpackValue(T& val) + void value(T& val) { assert(first + sizeof(T) <= last); @@ -46,16 +71,8 @@ struct Unpacker first += sizeof(T); } - template - T unpackValue() - { - T val; - unpackValue(val); - return val; - } - template - void unpackRest(Container& container) + void rawRange(Container& container) { using T = typename Container::value_type; assert((last - first) % sizeof(T) == 0); @@ -65,6 +82,10 @@ struct Unpacker for (; first != last; first += sizeof(T)) container.push_back(reinterpret_cast(*first)); } + +private: + const char *first; + const char *last; }; } } diff --git a/src/comms/protocol.hpp b/src/comms/protocol.hpp index 2f76607..da25a5c 100644 --- a/src/comms/protocol.hpp +++ b/src/comms/protocol.hpp @@ -18,23 +18,13 @@ struct Hello std::pair jobTypesRange; std::uint32_t hbTimeoutSecs; - std::string serialise() const + template + void pack(Pack& p) { - std::string buffer; - buffer.reserve(4 + 4 + 4); - - packValue(buffer, jobTypesRange.first); - packValue(buffer, jobTypesRange.second); - packValue(buffer, hbTimeoutSecs); - return buffer; - } - - void unserialise(const std::string& str) - { - Unpacker p{str}; - p.unpackValue(jobTypesRange.first); - p.unpackValue(jobTypesRange.second); - p.unpackValue(hbTimeoutSecs); + p.reserve(4 + 4 + 4); + p.value(jobTypesRange.first); + p.value(jobTypesRange.second); + p.value(hbTimeoutSecs); } }; @@ -42,19 +32,11 @@ struct Welcome { std::uint32_t hbTimeoutSecs; - std::string serialise() const - { - std::string buffer; - buffer.reserve(4); - - packValue(buffer, hbTimeoutSecs); - return buffer; - } - - void unserialise(const std::string& str) + template + void pack(Pack& p) { - Unpacker p{str}; - p.unpackValue(hbTimeoutSecs); + p.reserve(4); + p.value(hbTimeoutSecs); } }; @@ -64,23 +46,13 @@ struct Job std::uint32_t type; std::vector data; - std::string serialise() const - { - std::string buffer; - buffer.reserve(4 + 4 + data.size() * sizeof(double)); - - packValue(buffer, id); - packValue(buffer, type); - packRange(buffer, data.data(), data.data() + data.size()); - return buffer; - } - - void unserialise(const std::string& str) + template + void pack(Pack& p) { - Unpacker p{str}; - p.unpackValue(id); - p.unpackValue(type); - p.unpackRest(data); + p.reserve(4 + 4 + data.size() * sizeof(double)); + p.value(id); + p.value(type); + p.rawRange(data); } }; @@ -89,21 +61,12 @@ struct Result std::uint32_t id; double data; - std::string serialise() const + template + void pack(Pack& p) { - std::string buffer; - buffer.reserve(4 + sizeof(double)); - - packValue(buffer, id); - packValue(buffer, data); - return buffer; - } - - void unserialise(const std::string& str) - { - Unpacker p{str}; - p.unpackValue(id); - p.unpackValue(data); + p.reserve(4 + sizeof(double)); + p.value(id); + p.value(data); } }; @@ -112,21 +75,12 @@ struct BatchJob std::uint32_t id; std::vector data; - std::string serialise() const - { - std::string buffer; - buffer.reserve(4 + data.size() * sizeof(double)); - - packValue(buffer, id); - packRange(buffer, data.data(), data.data() + data.size()); - return buffer; - } - - void unserialise(const std::string& str) + template + void pack(Pack& p) { - Unpacker p{str}; - p.unpackValue(id); - p.unpackRest(data); + p.reserve(4 + data.size() * sizeof(double)); + p.value(id); + p.rawRange(data); } }; @@ -135,35 +89,30 @@ struct BatchResult std::uint32_t id; std::vector data; - std::string serialise() const - { - std::string buffer; - buffer.reserve(4 + data.size() * sizeof(double)); - - packValue(buffer, id); - packRange(buffer, data.data(), data.data() + data.size()); - return buffer; - } - - void unserialise(const std::string& str) + template + void pack(Pack& p) { - Unpacker p{str}; - p.unpackValue(id); - p.unpackRest(data); + p.reserve(4 + data.size() * sizeof(double)); + p.value(id); + p.rawRange(data); } }; template std::string serialise(const T& t) { - return t.serialise(); + std::string buf; + Packer packer{buf}; + const_cast(t).pack(packer); // trust me + return buf; } template T unserialise(const std::string& str) { T t; - t.unserialise(str); + Unpacker unpacker{str}; + t.pack(unpacker); return t; } diff --git a/src/test/binary.cpp b/src/test/binary.cpp index a1005df..25b71dd 100644 --- a/src/test/binary.cpp +++ b/src/test/binary.cpp @@ -18,10 +18,12 @@ TEST_CASE("can pack and unpack one value", "[binary]") std::int32_t a = 42; std::string buf; - packValue(buf, a); + Packer packer{buf}; + packer.value(a); Unpacker p{buf}; - const auto aa = p.unpackValue(); + std::int32_t aa; + p.value(aa); REQUIRE(aa == 42); } @@ -32,12 +34,15 @@ TEST_CASE("can pack and unpack two values", "[binary]") std::int8_t b = 1; std::string buf; - packValue(buf, a); - packValue(buf, b); + Packer packer{buf}; + packer.value(a); + packer.value(b); Unpacker p{buf}; - const auto aa = p.unpackValue(); - const auto bb = p.unpackValue(); + std::int32_t aa; + std::int8_t bb; + p.value(aa); + p.value(bb); REQUIRE(aa == 42); REQUIRE(bb == 1); From fda59e24c1d1be00f30909737637771015699dbc Mon Sep 17 00:00:00 2001 From: darrnshn Date: Fri, 15 Jul 2016 22:55:08 +1000 Subject: [PATCH 14/28] Remove zmq_addon --- external/cppzmq/zmq_addon.hpp | 465 ---------------------------------- src/comms/socket.cpp | 47 ++-- 2 files changed, 28 insertions(+), 484 deletions(-) delete mode 100644 external/cppzmq/zmq_addon.hpp diff --git a/external/cppzmq/zmq_addon.hpp b/external/cppzmq/zmq_addon.hpp deleted file mode 100644 index 403f7ab..0000000 --- a/external/cppzmq/zmq_addon.hpp +++ /dev/null @@ -1,465 +0,0 @@ -/* - Copyright (c) 2016 VOCA AS / Harald Nøkland - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to - deal in the Software without restriction, including without limitation the - rights to use, copy, modify, merge, publish, distribute, sublicense, and/or - sell copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in - all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS - IN THE SOFTWARE. -*/ - -#ifndef __ZMQ_ADDON_HPP_INCLUDED__ -#define __ZMQ_ADDON_HPP_INCLUDED__ - -#include -#include -#include -#include - -namespace zmq { - -#ifdef ZMQ_HAS_RVALUE_REFS - -/* - This class handles multipart messaging. It is the C++ equivalent of zmsg.h, - which is part of CZMQ (the high-level C binding). Furthermore, it is a major - improvement compared to zmsg.hpp, which is part of the examples in the ØMQ - Guide. Unnecessary copying is avoided by using move semantics to efficiently - add/remove parts. -*/ -class multipart_t -{ -private: - std::deque m_parts; - -public: - multipart_t() - {} - - multipart_t(socket_t& socket) - { - recv(socket); - } - - multipart_t(const void *src, size_t size) - { - addmem(src, size); - } - - multipart_t(const std::string& string) - { - addstr(string); - } - - multipart_t(message_t&& message) - { - add(std::move(message)); - } - - multipart_t(multipart_t&& other) - { - std::swap(m_parts, other.m_parts); - } - - multipart_t& operator=(multipart_t&& other) - { - std::swap(m_parts, other.m_parts); - return *this; - } - - virtual ~multipart_t() - { - clear(); - } - - void clear() - { - m_parts.clear(); - } - - size_t size() const - { - return m_parts.size(); - } - - bool empty() const - { - return m_parts.empty(); - } - - bool recv(socket_t& socket) - { - clear(); - bool more = true; - while (more) - { - message_t message; - if (!socket.recv(&message)) - return false; - more = message.more(); - add(std::move(message)); - } - return true; - } - - bool send(socket_t& socket) - { - bool more = size() > 0; - while (more) - { - message_t message = pop(); - more = size() > 0; - if (!socket.send(message, more ? ZMQ_SNDMORE : 0)) - return false; - } - clear(); - return true; - } - - void prepend(multipart_t&& other) - { - while (!other.empty()) - push(other.remove()); - } - - void append(multipart_t&& other) - { - while (!other.empty()) - add(other.pop()); - } - - void pushmem(const void *src, size_t size) - { - m_parts.push_front(message_t(src, size)); - } - - void addmem(const void *src, size_t size) - { - m_parts.push_back(message_t(src, size)); - } - - void pushstr(const std::string& string) - { - m_parts.push_front(message_t(string.data(), string.size())); - } - - void addstr(const std::string& string) - { - m_parts.push_back(message_t(string.data(), string.size())); - } - - template - void pushtyp(const T& type) - { - m_parts.push_front(message_t(&type, sizeof(type))); - } - - template - void addtyp(const T& type) - { - m_parts.push_back(message_t(&type, sizeof(type))); - } - - void push(message_t&& message) - { - m_parts.push_front(std::move(message)); - } - - void add(message_t&& message) - { - m_parts.push_back(std::move(message)); - } - - std::string popstr() - { - if (m_parts.empty()) - return ""; - std::string string(m_parts.front().data(), m_parts.front().size()); - m_parts.pop_front(); - return string; - } - - template - T poptyp() - { - if (m_parts.empty()) - return T(); - T type = *m_parts.front().data(); - m_parts.pop_front(); - return type; - } - - message_t pop() - { - if (m_parts.empty()) - return message_t(0); - message_t message = std::move(m_parts.front()); - m_parts.pop_front(); - return message; - } - - message_t remove() - { - if (m_parts.empty()) - return message_t(0); - message_t message = std::move(m_parts.back()); - m_parts.pop_back(); - return message; - } - - const message_t* peek(size_t index) const - { - if (index >= size()) - return nullptr; - return &m_parts[index]; - } - - template - static multipart_t create(const T& type) - { - multipart_t multipart; - multipart.addtyp(type); - return multipart; - } - - multipart_t clone() const - { - multipart_t multipart; - for (size_t i = 0; i < size(); i++) - multipart.addmem(m_parts[i].data(), m_parts[i].size()); - return multipart; - } - - std::string str() const - { - std::stringstream ss; - for (size_t i = 0; i < m_parts.size(); i++) - { - const unsigned char* data = m_parts[i].data(); - size_t size = m_parts[i].size(); - - // Dump the message as text or binary - bool isText = true; - for (size_t j = 0; j < size; j++) - { - if (data[j] < 32 || data[j] > 127) - { - isText = false; - break; - } - } - ss << "\n[" << std::dec << std::setw(3) << std::setfill('0') << size << "] "; - if (size >= 1000) - { - ss << "... (to big to print)"; - continue; - } - for (size_t j = 0; j < size; j++) - { - if (isText) - ss << static_cast(data[j]); - else - ss << std::hex << std::setw(2) << std::setfill('0') << static_cast(data[j]); - } - } - return ss.str(); - } - - bool equal(const multipart_t* other) const - { - if (size() != other->size()) - return false; - for (size_t i = 0; i < size(); i++) - if (!peek(i)->equal(other->peek(i))) - return false; - return true; - } - - static int test() - { - bool ok = true; - float num = 0; - std::string str = ""; - message_t msg; - - // Create two PAIR sockets and connect over inproc - context_t context(1); - socket_t output(context, ZMQ_PAIR); - socket_t input(context, ZMQ_PAIR); - output.bind("inproc://multipart.test"); - input.connect("inproc://multipart.test"); - - // Test send and receive of single-frame message - multipart_t multipart; - assert(multipart.empty()); - - multipart.push(message_t("Hello", 5)); - assert(multipart.size() == 1); - - ok = multipart.send(output); - assert(multipart.empty()); - assert(ok); - - ok = multipart.recv(input); - assert(multipart.size() == 1); - assert(ok); - - msg = multipart.pop(); - assert(multipart.empty()); - assert(std::string(msg.data(), msg.size()) == "Hello"); - - // Test send and receive of multi-frame message - multipart.addstr("A"); - multipart.addstr("BB"); - multipart.addstr("CCC"); - assert(multipart.size() == 3); - - multipart_t copy = multipart.clone(); - assert(copy.size() == 3); - - ok = copy.send(output); - assert(copy.empty()); - assert(ok); - - ok = copy.recv(input); - assert(copy.size() == 3); - assert(ok); - assert(copy.equal(&multipart)); - - multipart.clear(); - assert(multipart.empty()); - - // Test message frame manipulation - multipart.add(message_t("Frame5", 6)); - multipart.addstr("Frame6"); - multipart.addstr("Frame7"); - multipart.addtyp(8.0f); - multipart.addmem("Frame9", 6); - multipart.push(message_t("Frame4", 6)); - multipart.pushstr("Frame3"); - multipart.pushstr("Frame2"); - multipart.pushtyp(1.0f); - multipart.pushmem("Frame0", 6); - assert(multipart.size() == 10); - - msg = multipart.remove(); - assert(multipart.size() == 9); - assert(std::string(msg.data(), msg.size()) == "Frame9"); - - msg = multipart.pop(); - assert(multipart.size() == 8); - assert(std::string(msg.data(), msg.size()) == "Frame0"); - - num = multipart.poptyp(); - assert(multipart.size() == 7); - assert(num == 1.0f); - - str = multipart.popstr(); - assert(multipart.size() == 6); - assert(str == "Frame2"); - - str = multipart.popstr(); - assert(multipart.size() == 5); - assert(str == "Frame3"); - - str = multipart.popstr(); - assert(multipart.size() == 4); - assert(str == "Frame4"); - - str = multipart.popstr(); - assert(multipart.size() == 3); - assert(str == "Frame5"); - - str = multipart.popstr(); - assert(multipart.size() == 2); - assert(str == "Frame6"); - - str = multipart.popstr(); - assert(multipart.size() == 1); - assert(str == "Frame7"); - - num = multipart.poptyp(); - assert(multipart.empty()); - assert(num == 8.0f); - - // Test message constructors and concatenation - multipart_t head("One", 3); - head.addstr("Two"); - assert(head.size() == 2); - - multipart_t tail("One-hundred"); - tail.pushstr("Ninety-nine"); - assert(tail.size() == 2); - - multipart_t tmp(message_t("Fifty", 5)); - assert(tmp.size() == 1); - - multipart_t mid = multipart_t::create(49.0f); - mid.append(std::move(tmp)); - assert(mid.size() == 2); - assert(tmp.empty()); - - multipart_t merged(std::move(mid)); - merged.prepend(std::move(head)); - merged.append(std::move(tail)); - assert(merged.size() == 6); - assert(head.empty()); - assert(tail.empty()); - - ok = merged.send(output); - assert(merged.empty()); - assert(ok); - - multipart_t received(input); - assert(received.size() == 6); - - str = received.popstr(); - assert(received.size() == 5); - assert(str == "One"); - - str = received.popstr(); - assert(received.size() == 4); - assert(str == "Two"); - - num = received.poptyp(); - assert(received.size() == 3); - assert(num == 49.0f); - - str = received.popstr(); - assert(received.size() == 2); - assert(str == "Fifty"); - - str = received.popstr(); - assert(received.size() == 1); - assert(str == "Ninety-nine"); - - str = received.popstr(); - assert(received.empty()); - assert(str == "One-hundred"); - - return 0; - } - -private: - // Disable implicit copying (moving is more efficient) - multipart_t(const multipart_t& other) ZMQ_DELETED_FUNCTION; - void operator=(const multipart_t& other) ZMQ_DELETED_FUNCTION; -}; - -#endif - -} - -#endif diff --git a/src/comms/socket.cpp b/src/comms/socket.cpp index b3712ba..fcf9df1 100644 --- a/src/comms/socket.cpp +++ b/src/comms/socket.cpp @@ -1,6 +1,6 @@ //! Implementation of ZMQ socket wrappers. //! -//! \file comms/socket.cpp +//! \file src/comms/socket.cpp //! \author Lachlan McCalman //! \author Darren Shen //! \date 2014 @@ -15,8 +15,6 @@ #include #include -#include - namespace stateline { namespace comms { SocketBase::SocketBase(zmq::context_t& context, zmq::socket_type type, std::string name, int linger) @@ -45,38 +43,49 @@ void SocketBase::bind(const std::string& address) bool SocketBase::send(const std::string& address, const std::string& data) { - zmq::multipart_t msg; - if (!address.empty()) - msg.addstr(address); - msg.addstr(data); - // Send the message - if (msg.send(socket_)) + try { + if (!address.empty()) + socket_.send(address.c_str(), address.size(), ZMQ_SNDMORE); + socket_.send(data.c_str(), data.size()); + hb_.updateLastSendTime(address); return true; } - - // TODO: disconnect heartbeat immediately - return false; + catch(zmq::error_t) + { + // TODO: disconnect heartbeat immediately + return false; + } } std::pair SocketBase::recv() { - // Receive a multipart message - zmq::multipart_t msg{socket_}; - assert(msg.size() == 1 || msg.size() == 2); + zmq::message_t msg1, msg2; + std::string address, data; - // Get the address and data - auto address = msg.size() == 1 ? "" : msg.popstr(); - auto data = msg.popstr(); + // Get the address and data. We expect either one frame (data only) or two frames + // (address and data) + socket_.recv(&msg1); + if (msg1.more()) + { + socket_.recv(&msg2); + assert(!msg2.more()); + + address = std::string{msg1.data(), msg1.size()}; + data = std::string{msg2.data(), msg2.size()}; + } + else + { + data = std::string{msg1.data(), msg1.size()}; + } hb_.updateLastRecvTime(address); return {std::move(address), std::move(data)}; } - void SocketBase::setIdentity() { // Inspired by zhelpers.hpp From 327b30a6df43f4cf829d7f4626dd23bc01f40705 Mon Sep 17 00:00:00 2001 From: darrnshn Date: Thu, 21 Jul 2016 09:50:44 +1000 Subject: [PATCH 15/28] Tidy up endpoint --- src/comms/endpoint.hpp | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/src/comms/endpoint.hpp b/src/comms/endpoint.hpp index b8e5361..c52944a 100644 --- a/src/comms/endpoint.hpp +++ b/src/comms/endpoint.hpp @@ -10,7 +10,6 @@ #pragma once #include "comms/socket.hpp" -#include namespace stateline { namespace comms { @@ -51,6 +50,10 @@ class Endpoint self().onWelcome(m); break; + case BYE: + self().onBye(m); + break; + case JOB: self().onJob(m); break; @@ -69,14 +72,11 @@ class Endpoint default: // TODO: unrecognised subject - onDefault(m); + self().onDefault(m); break; } - - onAny(m); } - void onAny(const Message&) { } void onDefault(const Message&) { } void onHeartbeat(const Message& m) { self().onDefault(m); } void onHello(const Message& m) { self().onDefault(m); } @@ -87,6 +87,14 @@ class Endpoint void onBatchJob(const Message& m) { self().onDefault(m); } void onBatchResult(const Message& m) { self().onDefault(m); } + void onHeartbeatSend(const std::string& addr) { } + void onHeartbeatTimeout(const std::string& addr) { } + + void idle() + { + // handle heartbeats and disconnects + } + private: Base& self() { return *static_cast(this); } From 44e10fdfb2b682e68fbb3dc3daf636a0c68b61f2 Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Thu, 21 Jul 2016 10:12:16 +1000 Subject: [PATCH 16/28] Fix warnings --- src/comms/binary.hpp | 2 +- src/comms/delegator.hpp | 2 +- src/comms/message.cpp | 20 +++++++++++++++++--- src/comms/message.hpp | 10 ++-------- src/test/delegator.cpp | 4 ++-- 5 files changed, 23 insertions(+), 15 deletions(-) diff --git a/src/comms/binary.hpp b/src/comms/binary.hpp index 45d2cc4..b592a76 100644 --- a/src/comms/binary.hpp +++ b/src/comms/binary.hpp @@ -57,7 +57,7 @@ class Unpacker { } - void reserve(std::size_t capacity) + void reserve(std::size_t /*capacity*/) { // Does nothing } diff --git a/src/comms/delegator.hpp b/src/comms/delegator.hpp index ff55ef1..ad77850 100644 --- a/src/comms/delegator.hpp +++ b/src/comms/delegator.hpp @@ -51,7 +51,7 @@ class Delegator std::string address; // need to know who to send this back to std::vector data; // the batch job data std::vector results; // table of pending results - int numJobsDone; // number of completed jobs so far + std::size_t numJobsDone; // number of completed jobs so far PendingBatch(std::string address, std::vector data, std::size_t numJobTypes); }; diff --git a/src/comms/message.cpp b/src/comms/message.cpp index ccd2e15..a96c463 100644 --- a/src/comms/message.cpp +++ b/src/comms/message.cpp @@ -6,8 +6,24 @@ std::string subjectToString(Subject s) { switch (s) { + case HEARTBEAT: + return "HEARTBEAT"; case HELLO: return "HELLO"; + case WELCOME: + return "WELCOME"; + case BYE: + return "BYE"; + case JOB: + return "JOB"; + case RESULT: + return "RESULT"; + case BATCH_JOB: + return "BATCH_JOB"; + case BATCH_RESULT: + return "BATCH_RESULT"; + default: + return "UNKNOWN"; } return "UNKNOWN"; @@ -20,6 +36,4 @@ std::ostream& operator<<(std::ostream& os, const Message& m) return os; } -} // namespace comms - -} // namespace stateline +} } diff --git a/src/comms/message.hpp b/src/comms/message.hpp index 11437fc..3ec15d8 100644 --- a/src/comms/message.hpp +++ b/src/comms/message.hpp @@ -13,11 +13,7 @@ #include #include -namespace stateline -{ - -namespace comms -{ +namespace stateline { namespace comms { //! Represents all the message types used in Stateline. enum Subject : std::uint8_t // TODO: make this an enum class @@ -55,6 +51,4 @@ struct Message std::ostream& operator<<(std::ostream& os, const Message& m); -} - -} +} } diff --git a/src/test/delegator.cpp b/src/test/delegator.cpp index c275478..88ebbd7 100644 --- a/src/test/delegator.cpp +++ b/src/test/delegator.cpp @@ -70,7 +70,7 @@ TEST_CASE("delegator follows protocol", "[delegator]") { std::vector jobs; - for (auto i = 0; i < settings.numJobTypes; i++) + for (std::size_t i = 0; i < settings.numJobTypes; i++) { const auto msg = network.recv(); REQUIRE(msg.subject == JOB); @@ -82,7 +82,7 @@ TEST_CASE("delegator follows protocol", "[delegator]") std::sort(jobs.begin(), jobs.end(), [](auto&& a, auto&& b) { return a.id < b.id; }); - for (auto i = 0; i < settings.numJobTypes; i++) + for (std::size_t i = 0; i < settings.numJobTypes; i++) { REQUIRE(jobs[i].id == i + 1); REQUIRE(jobs[i].data.size() == 3); From 5cb24bd64ea39001327cb1b9e1625dc8128293c6 Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Thu, 21 Jul 2016 10:23:29 +1000 Subject: [PATCH 17/28] Change delegator network socket to bind --- src/comms/delegator.cpp | 6 +++--- src/comms/settings.hpp | 8 ++++---- src/test/delegator.cpp | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/comms/delegator.cpp b/src/comms/delegator.cpp index 6aab893..46ede58 100644 --- a/src/comms/delegator.cpp +++ b/src/comms/delegator.cpp @@ -194,12 +194,12 @@ Delegator::Delegator(zmq::context_t& ctx, const DelegatorSettings& settings) : state_{ctx, settings} { // Initialise the local sockets - state_.requester.bind(settings.bindAddress); - state_.network.connect(settings.networkAddress); + state_.requester.bind(settings.requesterAddress); + state_.network.bind(settings.networkAddress); // TODO: network_.setFallback([&](const Message& m) { sendFailed(m); }); - LOG(INFO) << "Delegator listening on " << settings.bindAddress; + LOG(INFO) << "Delegator listening on " << settings.networkAddress; } void Delegator::poll() diff --git a/src/comms/settings.hpp b/src/comms/settings.hpp index 266f6f2..9526c13 100644 --- a/src/comms/settings.hpp +++ b/src/comms/settings.hpp @@ -22,9 +22,9 @@ namespace stateline { namespace comms { struct DelegatorSettings { //! The address of this delegator which the requester connects to. - std::string bindAddress; + std::string requesterAddress; - //! The address of the agent to connect to. + //! The address for agents to connect to. std::string networkAddress; //! How long without heartbeats is considered time out. @@ -35,8 +35,8 @@ struct DelegatorSettings //! Construct default agent settings. //! - DelegatorSettings(std::string bindAddress, std::string networkAddress) - : bindAddress{std::move(bindAddress)} + DelegatorSettings(std::string requesterAddress, std::string networkAddress) + : requesterAddress{std::move(requesterAddress)} , networkAddress{std::move(networkAddress)} { heartbeatTimeout = std::chrono::seconds{15}; diff --git a/src/test/delegator.cpp b/src/test/delegator.cpp index 88ebbd7..9138692 100644 --- a/src/test/delegator.cpp +++ b/src/test/delegator.cpp @@ -27,12 +27,12 @@ TEST_CASE("delegator follows protocol", "[delegator]") settings.numJobTypes = 3; Socket network{ctx, zmq::socket_type::dealer, "network"}; - network.bind(settings.networkAddress); + network.connect(settings.networkAddress); Delegator delegator{ctx, settings}; Socket requester{ctx, zmq::socket_type::dealer, "requester"}; - requester.connect(settings.bindAddress); + requester.connect(settings.requesterAddress); SECTION("responds to HELLO from worker with WELCOME") { From bc3c584d89d82fde27cb9743e010425569e953ff Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Thu, 21 Jul 2016 12:02:12 +1000 Subject: [PATCH 18/28] Add simple delegator test for job delegation --- src/comms/delegator.cpp | 84 ++++++++++++++++++----------------------- src/comms/delegator.hpp | 18 ++++----- src/test/delegator.cpp | 75 ++++++++++++++++++++++++++++++++++++ 3 files changed, 119 insertions(+), 58 deletions(-) diff --git a/src/comms/delegator.cpp b/src/comms/delegator.cpp index 46ede58..29b1ec7 100644 --- a/src/comms/delegator.cpp +++ b/src/comms/delegator.cpp @@ -20,6 +20,17 @@ namespace stateline { namespace comms { +Delegator::Worker::JobDuration Delegator::Worker::estimatedFinishDurationForNewJob(JobType type) const +{ + const auto wipTime = std::accumulate(inProgress.begin(), inProgress.end(), 0.0, + [this](const auto& a, const auto& b) + { + return a + times.at(b.second.type).average(); + }); + + return JobDuration{static_cast(wipTime + times.at(type).average())}; +} + Delegator::PendingBatch::PendingBatch(std::string address, std::vector data, std::size_t numJobTypes) : address{std::move(address)} , data{std::move(data)} @@ -66,6 +77,30 @@ void Delegator::State::addBatch(const std::string& address, JobID id, std::vecto VLOG(2) << pending.size() << " requests pending"; } +Delegator::Worker* Delegator::State::bestWorker(const JobType type) +{ + Delegator::Worker* bestWorker = nullptr; + auto bestDuration = Worker::JobDuration::max(); + for (auto& it : workers) + { + auto& worker = it.second; + if (type >= worker.jobTypesRange.first && + type <= worker.jobTypesRange.second && + worker.inProgress.size() < worker.maxJobs) + { + const auto duration = worker.estimatedFinishDurationForNewJob(type); + if (duration < bestDuration || + (duration == bestDuration && worker.inProgress.size() < bestWorker->inProgress.size())) + { + bestWorker = &worker; + bestDuration = duration; + } + } + } + return bestWorker; +} + + struct Delegator::RequesterEndpoint : Endpoint { State& delegator; @@ -119,7 +154,7 @@ struct Delegator::NetworkEndpoint : Endpoint for (auto it = delegator.jobQueue.begin(); it != delegator.jobQueue.end(); ) { // TODO: find the best worker - Worker *worker = delegator.workers.size() == 0 ? nullptr : &delegator.workers.begin()->second; + Worker *worker = delegator.bestWorker(it->type); if (!worker) { ++it; @@ -152,7 +187,7 @@ struct Delegator::NetworkEndpoint : Endpoint Job& job = worker.inProgress.at(result.id); PendingBatch& batch = job.batch->second; - worker.times.at(job.type).add(std::chrono::duration_cast(Clock::now() - job.startTime).count()); + worker.times.at(job.type).add(std::chrono::duration(Clock::now() - job.startTime).count()); batch.results[job.type - 1] = result.data; // job types are 1-indexed batch.numJobsDone++; @@ -228,49 +263,4 @@ void Delegator::start(bool& running) } while (running); } -/* -Delegator::Worker* Delegator::bestWorker(uint jobType, uint maxJobs) -{ - // TODO: can we do this using an STL algorithm? - Delegator::Worker* best = nullptr; - uint bestTime = std::numeric_limits::max(); - for (auto& w : workers_) - { - if (jobType >= w.second.jobTypesRange.first && - jobType < w.second.jobTypesRange.second && - w.second.workInProgress.size() < maxJobs) - { - uint t = usTillDone(w.second, jobType); - if (t < bestTime) - { - best = &w.second; - bestTime = t; - } - } - } - return best; -} - -void Delegator::disconnectWorker(const std::string& addr) -{ - const auto it = workers_.find(m.address); - if (it == workers_.end()) - return; - - LOG(INFO)<< "Worker " << addr << " disconnected: re-assigning their jobs"; - - // Push all the unfinished work back into the queue - for (const auto& kv : it->wip) - jobQueue_.push_front(kv.second); - - workers_.erase(it); -} - -void Delegator::sendFailed(const Message& m) -{ - LOG(INFO) << "Failed to send to " << m.address; - - disconnectWorker(m.address); -} */ - } } diff --git a/src/comms/delegator.hpp b/src/comms/delegator.hpp index ad77850..3861e05 100644 --- a/src/comms/delegator.hpp +++ b/src/comms/delegator.hpp @@ -73,10 +73,13 @@ class Delegator struct Worker { + using JobDuration = std::chrono::microseconds; + std::string address; std::pair jobTypesRange; std::map inProgress; std::map> times; + std::size_t maxJobs = 10; // TODO: make this part of the HELLO msg Worker(std::string address, const std::pair& jobTypesRange) @@ -84,13 +87,9 @@ class Delegator , jobTypesRange{jobTypesRange} { } - }; - - /* - void idle(); - // TODO: does this need to be a member function? - Worker* bestWorker(uint jobType, uint maxJobs);*/ + JobDuration estimatedFinishDurationForNewJob(JobType type) const; + }; struct State { @@ -106,17 +105,14 @@ class Delegator void addWorker(const std::string& address, const std::pair& jobTypeRange); void addBatch(const std::string& address, JobID id, std::vector data); + + Worker* bestWorker(JobType type); }; struct RequesterEndpoint; struct NetworkEndpoint; State state_; - /* - std::map requests_; - std::list jobQueue_; - - JobID nextJobId_;*/ }; } } diff --git a/src/test/delegator.cpp b/src/test/delegator.cpp index 9138692..229c71e 100644 --- a/src/test/delegator.cpp +++ b/src/test/delegator.cpp @@ -121,3 +121,78 @@ TEST_CASE("delegator follows protocol", "[delegator]") } } } + +TEST_CASE("delegator delegates jobs fairly", "[delegator]") +{ + zmq::context_t ctx{1}; + + DelegatorSettings settings{"ipc://test_delegator", "ipc://test_network"}; + settings.heartbeatTimeout = 10s; + settings.numJobTypes = 2; + + Socket network1{ctx, zmq::socket_type::dealer, "network"}; + network1.connect(settings.networkAddress); + + Socket network2{ctx, zmq::socket_type::dealer, "network"}; + network2.connect(settings.networkAddress); + + Delegator delegator{ctx, settings}; + + Socket requester{ctx, zmq::socket_type::dealer, "requester"}; + requester.connect(settings.requesterAddress); + + SECTION("responds to HELLOs from workers") + { + { + protocol::Hello hello; + hello.jobTypesRange = std::make_pair(1, 2); + hello.hbTimeoutSecs = 20; + REQUIRE(network1.send({"", HELLO, serialise(hello)}) == true); + REQUIRE(network2.send({"", HELLO, serialise(hello)}) == true); + } + + // Poll twice because the messages are from the same socket + delegator.poll(); + delegator.poll(); + + { + const auto msg1 = network1.recv(); + REQUIRE(msg1.subject == WELCOME); + + const auto msg2 = network2.recv(); + REQUIRE(msg2.subject == WELCOME); + } + + SECTION("sends jobs to worker when BATCH JOB is received") + { + { + protocol::BatchJob batchJob; + batchJob.id = 1; + batchJob.data.push_back(1); // Should be sent to worker1 + batchJob.data.push_back(2); // Should be sent to worker1 again + batchJob.data.push_back(3); // Should be sent to worker2 + + REQUIRE(requester.send({"", BATCH_JOB, serialise(batchJob)}) == true); + } + + delegator.poll(); + + { + const auto msg1 = network1.recv(); + REQUIRE(msg1.subject == JOB); + + const auto msg2 = network2.recv(); + REQUIRE(msg2.subject == JOB); + + const auto job1 = protocol::unserialise(msg1.data); + const auto job2 = protocol::unserialise(msg2.data); + + // The two jobs should be split between the two workers + if (job1.id == 1) + REQUIRE(job2.id == 2); + else + REQUIRE(job2.id == 1); + } + } + } +} From 397df96fe34db5374a54ac73c5b5ece8af71c3eb Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Thu, 21 Jul 2016 12:29:05 +1000 Subject: [PATCH 19/28] Add simple heartbeat tests --- src/comms/heartbeat.cpp | 6 +-- src/comms/heartbeat.hpp | 2 +- src/test/heartbeat.cpp | 116 +++++++++++++++++++++++++++++++++++++--- 3 files changed, 114 insertions(+), 10 deletions(-) diff --git a/src/comms/heartbeat.cpp b/src/comms/heartbeat.cpp index d2bb908..a27d732 100644 --- a/src/comms/heartbeat.cpp +++ b/src/comms/heartbeat.cpp @@ -16,7 +16,7 @@ namespace stateline { namespace comms { Heartbeat::Heartbeat() : heartbeatCallback_{[](const auto&) { }} - , disconnectCallback_{[](const auto&) { }} + , disconnectCallback_{[](const auto&, auto) { }} { } @@ -43,7 +43,7 @@ void Heartbeat::disconnect(const std::string& addr, DisconnectReason reason) break; } - disconnectCallback_(addr); + disconnectCallback_(addr, reason); conns_.erase(addr); } @@ -87,7 +87,7 @@ void Heartbeat::idle() if (it->second.lastRecvTime + it->second.interval * 2 < now) { VLOG(1) << it->first << " timed out"; - disconnectCallback_(it->first); + disconnectCallback_(it->first, DisconnectReason::TIMEOUT); it = conns_.erase(it); } else diff --git a/src/comms/heartbeat.hpp b/src/comms/heartbeat.hpp index 4af47dd..08eeb0e 100644 --- a/src/comms/heartbeat.hpp +++ b/src/comms/heartbeat.hpp @@ -34,7 +34,7 @@ class Heartbeat using Clock = std::chrono::high_resolution_clock; using HeartbeatCallback = std::function; - using DisconnectCallback = std::function; + using DisconnectCallback = std::function; //! Construct a heartbeat manager. //! diff --git a/src/test/heartbeat.cpp b/src/test/heartbeat.cpp index f9b40e3..89ca4fc 100644 --- a/src/test/heartbeat.cpp +++ b/src/test/heartbeat.cpp @@ -19,7 +19,16 @@ using namespace std::chrono_literals; TEST_CASE("heartbeat can connect and disconnect", "[heartbeat]") { + bool disconnectCalled = false; + Heartbeat hb; + hb.bindDisconnect( + [&disconnectCalled](const auto& addr, auto reason) + { + REQUIRE((reason == DisconnectReason::USER_REQUESTED)); + REQUIRE(addr == "foo"); + disconnectCalled = true; + }); SECTION("defaults to no connections") { @@ -37,10 +46,15 @@ TEST_CASE("heartbeat can connect and disconnect", "[heartbeat]") REQUIRE(hb.numConnections() == 1); } - SECTION("disconnect updates connections") + SECTION("disconnect calls disconnect callback") { hb.disconnect("foo"); - REQUIRE(hb.numConnections() == 0); + REQUIRE(disconnectCalled == true); + + SECTION("update connections") + { + REQUIRE(hb.numConnections() == 0); + } SECTION("disconnecting same address does nothing") { @@ -49,10 +63,100 @@ TEST_CASE("heartbeat can connect and disconnect", "[heartbeat]") } } } +} + +TEST_CASE("heartbeats timeout when no heartbeats are sent", "[heartbeat]") +{ + bool timeoutCalled = false; + + Heartbeat hb; + hb.bindDisconnect( + [&timeoutCalled](const auto& addr, auto reason) + { + REQUIRE(timeoutCalled == false); + timeoutCalled = true; + REQUIRE(addr == "foo"); + REQUIRE(reason == DisconnectReason::TIMEOUT); + }); + + hb.connect("foo", 1s); + + SECTION("calls timeout callback") + { + std::this_thread::sleep_for(1s); + hb.idle(); + + REQUIRE(timeoutCalled == true); + + SECTION("removes the connection") + { + REQUIRE(hb.numConnections() == 0); + } + } +} + +TEST_CASE("heartbeats don't timeout when heartbeats are sent", "[heartbeat]") +{ + int heartbeatCalled = 0; + + Heartbeat hb; + hb.bindHeartbeat( + [&heartbeatCalled](const auto& addr) + { + REQUIRE(addr == "foo"); + heartbeatCalled++; + }); + hb.bindDisconnect([](const auto&, auto) { REQUIRE(false); }); + + hb.connect("foo", 1s); + + SECTION("calls heartbeat callback on idle") + { + std::this_thread::sleep_for(500ms); + hb.updateLastRecvTime("foo"); + hb.idle(); + + REQUIRE(heartbeatCalled == 1); + + SECTION("keeps the connection") + { + REQUIRE(hb.numConnections() == 1); + } - /* - std::this_thread::sleep_for(500ms); - hb.connect("bar", 1s); + SECTION("calls heartbeat callback on second idle") + { + std::this_thread::sleep_for(500ms); + hb.updateLastRecvTime("foo"); + hb.idle(); + + REQUIRE(heartbeatCalled == 2); + + SECTION("keeps the connection") + { + REQUIRE(hb.numConnections() == 1); + } + + SECTION("times out when we miss a heartbeat") + { + bool timeoutCalled = false; + hb.bindDisconnect( + [&timeoutCalled](const auto& addr, auto reason) + { + timeoutCalled = true; + REQUIRE(addr == "foo"); + REQUIRE(reason == DisconnectReason::TIMEOUT); + }); + + std::this_thread::sleep_for(1s); + hb.idle(); - REQUIRE(hb.idle() < 500ms);*/ + SECTION("removes the connection") + { + REQUIRE(hb.numConnections() == 0); + } + } + } + } } + +// TODO: add test with multiple connections From ce3e5d74c8b82cd2a1faf96a2cb0457a838db85f Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Thu, 21 Jul 2016 15:58:48 +1000 Subject: [PATCH 20/28] Server and agent not crashing --- CMakeLists.txt | 23 +- src/app/CMakeLists.txt | 2 +- src/app/api.cpp | 144 --------- src/app/api.hpp | 22 -- src/app/json.hpp | 53 +++ src/app/jsonsettings.hpp | 78 ----- src/app/logging.cpp | 6 +- src/app/serverwrapper.cpp | 303 +++++++++--------- src/app/serverwrapper.hpp | 165 +++++----- src/bin/CMakeLists.txt | 12 +- src/bin/agent.cpp | 5 +- .../{demo-config.json => config.default.json} | 0 src/bin/demo-worker.py | 85 ----- src/bin/{stateline.cpp => server.cpp} | 31 +- src/bin/stateline-server.cpp | 83 ----- src/bin/vis.py | 20 -- src/comms/agent.cpp | 15 +- src/comms/delegator.cpp | 3 +- src/comms/delegator.hpp | 2 + src/comms/router.hpp | 7 +- src/comms/socket.cpp | 4 +- src/infer/adaptive.cpp | 2 +- src/infer/logging.cpp | 23 -- src/infer/logging.hpp | 3 - src/infer/sampler.hpp | 33 +- src/test/CMakeLists.txt | 2 +- src/test/agent.cpp | 21 +- 27 files changed, 378 insertions(+), 769 deletions(-) delete mode 100644 src/app/api.cpp delete mode 100644 src/app/api.hpp create mode 100644 src/app/json.hpp delete mode 100644 src/app/jsonsettings.hpp rename src/bin/{demo-config.json => config.default.json} (100%) delete mode 100644 src/bin/demo-worker.py rename src/bin/{stateline.cpp => server.cpp} (72%) delete mode 100644 src/bin/stateline-server.cpp delete mode 100644 src/bin/vis.py diff --git a/CMakeLists.txt b/CMakeLists.txt index d0b65ed..e18f7b3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -129,24 +129,19 @@ ADD_SUBPROJECT(src/bin) ############################################################################## # Build final libraries for server and client ############################################################################## -ADD_LIBRARY(statelineserver STATIC #SHARED - $ #$ - $ $ - $ $) - -TARGET_LINK_LIBRARIES(statelineserver ${Boost_LIBRARIES} ${ZMQ_LIBRARY}) -SET_TARGET_PROPERTIES(statelineserver PROPERTIES LINKER_LANGUAGE CXX) ADD_LIBRARY(stateline-server STATIC - $ - $ $) + $ $ + $ $ + $ $) TARGET_LINK_LIBRARIES(stateline-server ${ZMQ_LIBRARY}) +SET_TARGET_PROPERTIES(stateline-server PROPERTIES LINKER_LANGUAGE CXX) -ADD_LIBRARY(statelineclient STATIC #SHARED +ADD_LIBRARY(stateline-client STATIC $ $ $) -TARGET_LINK_LIBRARIES(statelineclient ${ZMQ_LIBRARY}) -SET_TARGET_PROPERTIES(statelineclient PROPERTIES LINKER_LANGUAGE CXX) +TARGET_LINK_LIBRARIES(stateline-client ${ZMQ_LIBRARY}) +SET_TARGET_PROPERTIES(stateline-client PROPERTIES LINKER_LANGUAGE CXX) ############################################################################## # Move the frontend code to the build folder @@ -156,9 +151,9 @@ FILE(COPY frontend DESTINATION ${STATELINE_BINARY_DIR}) ############################################################################## # Install binaries ############################################################################## -install (TARGETS statelineserver +install (TARGETS stateline-server ARCHIVE DESTINATION lib LIBRARY DESTINATION lib) -install (TARGETS statelineclient +install (TARGETS stateline-client ARCHIVE DESTINATION lib LIBRARY DESTINATION lib) diff --git a/src/app/CMakeLists.txt b/src/app/CMakeLists.txt index 2f7bc3b..f0e9541 100644 --- a/src/app/CMakeLists.txt +++ b/src/app/CMakeLists.txt @@ -6,4 +6,4 @@ # Date: 2014 ADD_LIBRARY(commonwrapper OBJECT logging.cpp signal.cpp) -#ADD_LIBRARY(serverwrapper OBJECT serverwrapper.cpp api.cpp) +ADD_LIBRARY(serverwrapper OBJECT serverwrapper.cpp) diff --git a/src/app/api.cpp b/src/app/api.cpp deleted file mode 100644 index 6792451..0000000 --- a/src/app/api.cpp +++ /dev/null @@ -1,144 +0,0 @@ -#include "api.hpp" - -//#include -#include -#include -//#include - -//using HttpServer = SimpleWeb::Server; -//namespace fs = boost::filesystem; - -namespace stateline -{ - void ApiResources::set(const std::string& name, json data) - { - mutex_.lock(); - resources_[name] = data.dump(); - mutex_.unlock(); - } - - std::string ApiResources::get(const std::string& name) - { - mutex_.lock(); - auto result = resources_[name]; - mutex_.unlock(); - return result; - } - - std::string ApiResources::getAll() - { - mutex_.lock(); - auto result = resources_; - mutex_.unlock(); - - std::string str = "{"; - for (auto it = result.begin(); it != result.end(); ++it) { - if (it != result.begin()) str += ","; - str += "\"" + it->first + "\": " + it->second; - } - return str + "}"; - } - - /* - void runApiServerThread(HttpServer& server) - { - server.start(); - }*/ - - void runApiServer(uint port, ApiResources& res, bool& running) - { - /* TODO: use graphite - HttpServer server(port, 4); - - server.resource["^/test$"]["GET"] = [](HttpServer::Response &resp, std::shared_ptr request) - { - resp << "HTTP/1.1 200 OK\r\nContent-Length: " << 5 << "\r\n\r\n" << "hello"; - }; - - server.resource["^/chains$"]["GET"] = - [&res](HttpServer::Response &resp, std::shared_ptr request) - { - std::string content = res.get("chains"); - resp << "HTTP/1.1 200 OK\r\nContent-Length: " << content.length() << "\r\n\r\n" << content; - }; - - server.resource["^/all$"]["GET"] = - [&res](HttpServer::Response &resp, std::shared_ptr request) - { - std::string content = res.getAll(); - resp << "HTTP/1.1 200 OK\r\nContent-Length: " << content.length() << "\r\n\r\n" << content; - }; - - // Adapted from https://github.com/eidheim/Simple-Web-Server/blob/master/http_examples.cpp - server.default_resource["GET"] = - [](HttpServer::Response &resp, std::shared_ptr request) - { - fs::path webRoot("frontend"); - if (!fs::exists(webRoot)) - { - std::string content = "Server is misconfigured."; - resp << "HTTP/1.1 400 Bad Request\r\nContent-Length: " << content.length() << "\r\n\r\n" << content; - return; - } - - auto path = webRoot; - path += request->path; - if (fs::is_directory(path)) - path += "index.html"; - - if (fs::exists(path) && fs::is_regular_file(path)) - { - std::ifstream ifs(path.string(), std::ifstream::in | std::ifstream::binary); - if (!ifs) - { - std::string content = "Not found."; - resp << "HTTP/1.1 404 Not Found\r\nContent-Length: " << content.length() << "\r\n\r\n" << content; - return; - } - - // From the simple web example https://github.com/eidheim/Simple-Web-Server/blob/master/http_examples.cpp - ifs.seekg(0, std::ios::end); - size_t length = ifs.tellg(); - - ifs.seekg(0, std::ios::beg); - - resp << "HTTP/1.1 200 OK\r\nContent-Length: " << length << "\r\n\r\n"; - - // Read and send 128 KB at a time - uint buffer_size=131072; - std::vector buffer; - buffer.reserve(buffer_size); - uint read_length; - try - { - while((read_length=ifs.read(&buffer[0], buffer_size).gcount())>0) - { - resp.write(&buffer[0], read_length); - resp.flush(); - } - } - catch(const std::exception &e) - { - std::cerr << "Connection interrupted, closing file" << std::endl; - } - - ifs.close(); - } - else - { - std::string content = "Not found."; - resp << "HTTP/1.1 404 Not Found\r\nContent-Length: " << content.length() << "\r\n\r\n" << content; - } - }; - - auto future = std::async(std::launch::async, runApiServerThread, std::ref(server)); - - while (running) - { - std::this_thread::sleep_for(std::chrono::seconds(1)); - } - - server.stop(); - future.wait();*/ - } -} diff --git a/src/app/api.hpp b/src/app/api.hpp deleted file mode 100644 index da0e948..0000000 --- a/src/app/api.hpp +++ /dev/null @@ -1,22 +0,0 @@ -#pragma once - -#include -#include - -using json = nlohmann::json; - -namespace stateline -{ - class ApiResources { - public: - std::string get(const std::string& resource); - std::string getAll(); - void set(const std::string& resource, json data); - - private: - std::map resources_; - std::mutex mutex_; - }; - - void runApiServer(uint port, ApiResources& res, bool& running); -} diff --git a/src/app/json.hpp b/src/app/json.hpp new file mode 100644 index 0000000..daefba0 --- /dev/null +++ b/src/app/json.hpp @@ -0,0 +1,53 @@ +//! Helpers to work with JSON. +//! +//! \file app/json.hpp +//! \author Lachlan McCalman +//! \date 2015 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2015, NICTA +//! + +#pragma once + +#include +#include +#include + +namespace stateline { + +template +void readFields(const nlohmann::json& j, T& val) +{ + val = j.get(); +} + +template +void readFields(const nlohmann::json& j, Field&& field, Fields&&... fields, T& val) +{ + if (j.count(field)) + { + readFields(j[field], std::forward(fields)..., val); + } + else + { + LOG(ERROR) << field << " not found in config file and no default value exists. Exiting."; + exit(EXIT_FAILURE); + } +} + +template +void readFieldsWithDefault(const nlohmann::json& j, T& val, const S&) +{ + val = j.get(); +} + +template +void readFieldsWithDefault(const nlohmann::json& j, Field&& field, Fields&&... fields, T& val, const S& def) +{ + if (j.count(field)) + readFieldsWithDefault(j[field], std::forward(fields)..., val, def); + else + val = def; +} + +} diff --git a/src/app/jsonsettings.hpp b/src/app/jsonsettings.hpp deleted file mode 100644 index c076ef5..0000000 --- a/src/app/jsonsettings.hpp +++ /dev/null @@ -1,78 +0,0 @@ -#pragma once -//! -//! JSON Settings reader -//! -//! -//! -//! \file app/jsonsettings.hpp -//! \author Lachlan McCalman -//! \date 2015 -//! \license Lesser General Public License version 3 or later -//! \copyright (c) 2015, NICTA -//! - -#include -#include -#include - -namespace stateline -{ - - template - T readSettings(const nlohmann::json& j, const std::string& field) - { - try - { - T val = j[field].get(); - return val; - } - catch(...) - { - LOG(ERROR) << field << " not found in config file and no default value exists. Exiting."; - exit(EXIT_FAILURE); - } - } - - template - T readSettings(const nlohmann::json& j, const std::string& field1, const std::string& field2) - { - try - { - T val = j[field1][field2].get(); - return val; - } - catch(...) - { - LOG(ERROR) << field1 << ":" << field2 << " not found in config file and no default value exists. Exiting."; - exit(EXIT_FAILURE); - } - } - - template - T readWithDefault(const nlohmann::json& j, const std::string& field, const T& def) - { - if (j.count(field)) - return j[field].get(); - else - return def; - } - - template - T readWithDefault(const nlohmann::json& j, const std::string& field1 , const std::string& field2, const T& def) - { - if (j.count(field1) && j[field1].count(field2)) - return j[field1][field2].get(); - else - return def; - } - - template - T readWithDefault(const nlohmann::json& j, const std::string& field1 , const std::string& field2, const std::string& field3, const T& def) - { - if (j.count(field1) && j[field1].count(field2) && j[field1][field2].count(field3)) - return j[field1][field2][field3].get(); - else - return def; - } - -} // namespace stateline diff --git a/src/app/logging.cpp b/src/app/logging.cpp index 8dfade3..b2adf8d 100644 --- a/src/app/logging.cpp +++ b/src/app/logging.cpp @@ -14,8 +14,10 @@ #include #include +#define ELPP_DISABLE_DEFAULT_CRASH_HANDLING #include +// Don't want to get annoying crash messages when we ctrl-c INITIALIZE_EASYLOGGINGPP namespace stateline @@ -34,7 +36,7 @@ namespace stateline defaultConf.setToDefault(); defaultConf.setGlobally( - el::ConfigurationType::Format, "%datetime %level %msg"); + el::ConfigurationType::Format, "%datetime [%level] %msg"); defaultConf.setGlobally( el::ConfigurationType::ToStandardOutput, stdOut ? "true" : "false"); defaultConf.setGlobally( @@ -46,6 +48,8 @@ namespace stateline // is a bit tricky on easylogging. Will implement if needed. el::Loggers::setVerboseLevel(vLevel); + el::Loggers::reconfigureLogger("default", defaultConf); + LOG(INFO) << "Logging initialised with level " << normLog << " and verbosity " << vLevel; } diff --git a/src/app/serverwrapper.cpp b/src/app/serverwrapper.cpp index a2a1d50..e600bce 100644 --- a/src/app/serverwrapper.cpp +++ b/src/app/serverwrapper.cpp @@ -1,180 +1,187 @@ +//! Implementation of the server wrapper. +//! +//! \file app/serverwrapper.cpp +//! \author Lachlan McCalman +//! \author Darren Shen +//! \date 2015 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2015, NICTA +//! + #include "serverwrapper.hpp" -#include "../infer/sampler.hpp" -#include "../infer/adaptive.hpp" -#include "../infer/logging.hpp" -namespace stateline -{ - namespace - { - void updateWorkerApi(ApiResources& api, comms::Delegator& delegator) - { - //api.set("workers", json({{ "count", delegator.workerCount() }})); - } - } +#include "infer/sampler.hpp" +#include "infer/adaptive.hpp" +#include "infer/logging.hpp" - void runServer(comms::Delegator& delegator) - { - delegator.start(); - } +namespace stateline { - std::pair generateInitialSample( - const StatelineSettings& s, comms::Requester& requester, - const mcmc::ProposalBounds& bounds) - { - Eigen::VectorXd sample; +namespace { - std::vector jobTypes(s.nJobTypes); - std::iota(jobTypes.begin(), jobTypes.end(), 0); +std::vector eigenVectorToStdVector(const Eigen::VectorXd& v) +{ + return {v.data(), v.data() + v.size()}; +} - // Send a random sample to workers to be evaluated - if (s.useInitial) - sample = mcmc::bouncyBounds(s.initial, bounds.min, bounds.max); - else - sample = mcmc::bouncyBounds(Eigen::VectorXd::Random(s.ndims), - bounds.min, bounds.max); - - requester.submit(0, jobTypes, sample); //job id zero because we dont care - auto result = requester.retrieve(); - double energy = std::accumulate(std::begin(result.second), std::end(result.second), 0.0); - return {sample, energy}; - } +void runServer(comms::Delegator& delegator, bool& running) +{ + delegator.start(running); +} +std::pair generateInitialSample( + const StatelineSettings& s, comms::Requester& requester, + const mcmc::ProposalBounds& bounds) +{ + Eigen::VectorXd sample; + + // Send a random sample to workers to be evaluated + if (s.useInitial) + sample = mcmc::bouncyBounds(s.initial, bounds.min, bounds.max); + else + sample = mcmc::bouncyBounds(Eigen::VectorXd::Random(s.ndims), + bounds.min, bounds.max); + + requester.submit(0, eigenVectorToStdVector(sample)); // job id zero because we dont care + const auto result = requester.retrieve(); + const double energy = std::accumulate(std::begin(result.second), std::end(result.second), 0.0); + return {sample, energy}; +} - void runSampler(const StatelineSettings& s, zmq::context_t& context, ApiResources& api, comms::Delegator& delegator, bool& running) +void runSampler(const StatelineSettings& s, zmq::context_t& ctx, comms::Delegator& delegator, bool& running) +{ + // Allocate adapters and proposal + const double max_log_ratio = 4.; // or would 10 be a better range + const double min_log_ratio = -8.; + const std::size_t initial_count = 1000; // TODO: make these settings + mcmc::RegressionAdapter sigmaAdapter(s.nstacks, s.ntemps, s.optimalAcceptRate, min_log_ratio, max_log_ratio); + mcmc::RegressionAdapter betaAdapter(s.nstacks, s.ntemps, s.optimalSwapRate, 0., max_log_ratio); + mcmc::GaussianProposal proposal(s.nstacks, s.ntemps, s.ndims, s.proposalBounds, initial_count); + mcmc::ChainArray chains(s.nstacks, s.ntemps, s.outputPath); + comms::Requester requester{ctx, delegator.settings().requesterAddress}; + + // Initialise chains to valid states + // TODO(AL) This loop could be parallelised, but it would take care... + for (uint i = 0; i < s.nstacks * s.ntemps; i++) { - // Allocate adapters and proposal - const double max_log_ratio = 4.; // or would 10 be a better range - const double min_log_ratio = -8.; - const uint initial_count = 1000; - mcmc::RegressionAdapter sigmaAdapter(s.nstacks, s.ntemps, s.optimalAcceptRate, min_log_ratio, max_log_ratio); - mcmc::RegressionAdapter betaAdapter(s.nstacks, s.ntemps, s.optimalSwapRate, 0., max_log_ratio); - mcmc::GaussianProposal proposal(s.nstacks, s.ntemps, s.ndims, s.proposalBounds, initial_count); - mcmc::ChainArray chains(s.nstacks, s.ntemps, s.outputPath); - comms::Requester requester(context); + // Draw an initial sample and compute its energy + Eigen::VectorXd sample; + double energy; + std::tie(sample, energy) = generateInitialSample(s,requester, + s.proposalBounds); + // Init betas + if (i % s.ntemps == 0) + betaAdapter.computeBetaStack(i); - // Initialise chains to valid states - // TODO(AL) This loop could be parallelised, but it would take care... - for (uint i = 0; i < s.nstacks * s.ntemps; i++) - { + // Initialise this chain with the evaluated sample + chains.initialise(i, sample, energy, sigmaAdapter.values()[i], + betaAdapter.values()[i]); - // Draw an initial sample and compute its energy - Eigen::VectorXd sample; - double energy; - std::tie(sample, energy) = generateInitialSample(s,requester, - s.proposalBounds); + LOG(INFO) << "Initialising chain " << i << " with energy: " << energy + << "sigma: " << sigmaAdapter.values()[i] << " and beta " + << betaAdapter.values()[i]; - // Init betas - if (i % s.ntemps == 0) - betaAdapter.computeBetaStack(i); + } - // Initialise this chain with the evaluated sample - chains.initialise(i, sample, energy, sigmaAdapter.values()[i], - betaAdapter.values()[i]); + // Create job types from 0 to max number of job types + std::vector jobTypes(s.nJobTypes); + std::iota(jobTypes.begin(), jobTypes.end(), 0); - LOG(INFO) << "Initialising chain " << i << " with energy: " << energy - << "sigma: " << sigmaAdapter.values()[i] << " and beta " - << betaAdapter.values()[i]; + mcmc::Sampler sampler(requester, chains, proposal, sigmaAdapter, + betaAdapter, s.swapInterval); + mcmc::TableLogger logger(s.nstacks, s.ntemps, s.ndims, s.loggingRateSec * 1000.0); + + // Chain ID and corresponding state. + uint id; + mcmc::State state; + + // Main Loop + // TODO(Al) confirm that sampler.step does not have to be thread-safe + // as I believe there is only one main loop running. + uint nsamples = 0; + while (nsamples < s.nsamples && running) + { + try + { + std::tie(id, state) = sampler.step(); + // 'id' is the ID of the chain and 'state' is its newest state. + if (id % s.ntemps == 0) + nsamples++; + } + catch (std::exception const& e) + { + LOG(INFO) << "Error in sampler step - aborting:"; + LOG(INFO) << e.what(); + break; + } + catch (...) + { + LOG(INFO) << "Error in sampler step - aborting:"; + break; } - // Create job types from 0 to max number of job types - std::vector jobTypes(s.nJobTypes); - std::iota(jobTypes.begin(), jobTypes.end(), 0); + // All the adaption can now be found in sampler.step - mcmc::Sampler sampler(requester, jobTypes, chains, proposal, sigmaAdapter, - betaAdapter, s.swapInterval); + // Log the update + logger.update(id, state, + sigmaAdapter.values(), sigmaAdapter.rates(), + betaAdapter.values(), betaAdapter.rates()); + } - mcmc::TableLogger logger(s.nstacks, s.ntemps, s.ndims, s.msLoggingRefresh); + // Finish any outstanding jobs + LOG(INFO) << "Finished MCMC job with " << nsamples << " samples."; + sampler.flush(); + if (running == false) + LOG(INFO) << "Running == False"; + running = false; +} - // Chain ID and corresponding state. - uint id; - mcmc::State state; +comms::DelegatorSettings delegatorSettings(int port, const StatelineSettings& s) +{ + comms::DelegatorSettings del{"ipc://stateline.socket", "tcp://*:" + std::to_string(port)}; + del.numJobTypes = s.nJobTypes; + del.heartbeatTimeout = std::chrono::seconds{s.heartbeatTimeoutSec}; + return del; +} - // Main Loop - // TODO(Al) confirm that sampler.step does not have to be thread-safe - // as I believe there is only one main loop running. - uint nsamples = 0; - while (nsamples < s.nsamples && running) - { - try - { - std::tie(id, state) = sampler.step(); - // 'id' is the ID of the chain and 'state' is its newest state. - if (id % s.ntemps == 0) - nsamples++; - } - catch (std::exception const& e) - { - LOG(INFO) << "Error in sampler step - aborting:"; - LOG(INFO) << e.what(); - break; - } - catch (...) - { - LOG(INFO) << "Error in sampler step - aborting:"; - break; - } - - // All the adaption can now be found in sampler.step - - // Log the update - logger.update(id, state, - sigmaAdapter.values(), sigmaAdapter.rates(), - betaAdapter.values(), betaAdapter.rates()); - logger.updateApi(api, chains); - updateWorkerApi(api, delegator); +} // namespace - } +ServerWrapper::ServerWrapper(int port, const StatelineSettings& s) + : settings_{s} + , running_{false} + , context_{1} + , delegator_{context_, delegatorSettings(port, s)} +{ +} - // Finish any outstanding jobs - LOG(INFO) << "Finished MCMC job with " << nsamples << " samples."; - sampler.flush(); - if (running == false) - LOG(INFO) << "Running == False"; - running = false; - } +ServerWrapper::~ServerWrapper() +{ + stop(); +} - ServerWrapper::ServerWrapper(uint port, const StatelineSettings& s) - : settings_(s) - , running_(false) - , context_{new zmq::context_t{1}} - , delegator_{*context_, comms::DelegatorSettings::Default(port), running_} - { - } +void ServerWrapper::start() +{ + running_ = true; - void ServerWrapper::start() - { - running_ = true; + serverThread_ = std::async(std::launch::async, runServer, std::ref(delegator_), std::ref(running_)); + samplerThread_ = std::async(std::launch::async, runSampler, std::cref(settings_), + std::ref(context_), std::ref(std::ref(delegator_)), std::ref(running_)); +} - serverThread_ = std::async(std::launch::async, runServer, std::ref(delegator_)); - samplerThread_ = std::async(std::launch::async, runSampler, std::cref(settings_), - std::ref(*context_), std::ref(api_), std::ref(std::ref(delegator_)), std::ref(running_)); - apiServerThread_ = std::async(std::launch::async, runApiServer, 8080, std::ref(api_), std::ref(running_)); - } +void ServerWrapper::stop() +{ + running_ = false; - void ServerWrapper::stop() - { - running_ = false; - if (context_) - { - delete context_; - context_ = nullptr; // ALWAYS DO THIS - } - // Wait for futures to finish - serverThread_.wait(); - samplerThread_.wait(); - } + // Wait for futures to finish + serverThread_.wait(); + samplerThread_.wait(); +} - bool ServerWrapper::isRunning() - { - return running_; - } +bool ServerWrapper::isRunning() const +{ + return running_; +} - ServerWrapper::~ServerWrapper() - { - stop(); - } } diff --git a/src/app/serverwrapper.hpp b/src/app/serverwrapper.hpp index 1c0a3c8..d705681 100644 --- a/src/app/serverwrapper.hpp +++ b/src/app/serverwrapper.hpp @@ -1,5 +1,4 @@ -//! -//! Main entry point for using stateline -- server side +//! Wrapper around the inference enginer and a delegator. //! //! \file app/serverwrapper.hpp //! \author Lachlan McCalman @@ -7,17 +6,18 @@ //! \license Lesser General Public License version 3 or later //! \copyright (c) 2015, NICTA //! + #pragma once #include #include #include -#include "jsonsettings.hpp" -#include "api.hpp" -#include "../infer/adaptive.hpp" -#include "../infer/chainarray.hpp" -#include "../infer/sampler.hpp" -#include "../comms/delegator.hpp" + +#include "app/json.hpp" +#include "comms/delegator.hpp" +#include "infer/adaptive.hpp" +#include "infer/chainarray.hpp" +#include "infer/sampler.hpp" // Ideal config file should look like: // { @@ -33,82 +33,81 @@ // "swapInterval": 10 // } -namespace stateline +namespace stateline { + +struct StatelineSettings { - struct StatelineSettings - { - uint ndims; - uint nstacks; - // uint nchains; - uint ntemps; - // uint annealLength; - uint nsamples; - uint swapInterval; - // int msLoggingRefresh; - uint msLoggingRefresh; - uint nJobTypes; - - bool useInitial; - - Eigen::VectorXd initial; - - // mcmc::SlidingWindowSigmaSettings sigmaSettings; - // mcmc::SlidingWindowBetaSettings betaSettings; - double optimalAcceptRate; - double optimalSwapRate; - std::string outputPath; - // mcmc::ChainSettings chainSettings; - mcmc::ProposalBounds proposalBounds; - - - static StatelineSettings fromJSON(const nlohmann::json& j) - { - StatelineSettings s; - s.nstacks = readSettings(j, "nStacks"); - s.ntemps = readSettings(j, "nTemperatures"); - s.nsamples = readSettings(j, "nSamplesTotal"); - s.swapInterval = readSettings(j,"swapInterval"); - s.msLoggingRefresh = (uint)(readSettings(j, "loggingRateSec")*1000.0); - s.nJobTypes = readSettings(j, "nJobTypes"); - s.outputPath = readSettings(j, "outputPath"); - s.optimalAcceptRate = readSettings(j, "optimalAcceptRate"); - s.optimalSwapRate = readSettings(j, "optimalSwapRate"); - s.useInitial = readSettings(j, "useInitial"); - - if (s.useInitial) - { - std::vector tmp; - tmp = readSettings>(j, "initial"); - uint nDims = tmp.size(); - s.initial.resize(nDims); - for (uint i=0; i < nDims; ++i) - s.initial[i] = tmp[i]; - } - - s.proposalBounds = mcmc::ProposalBoundsFromJSON(j); - s.ndims = (uint)s.proposalBounds.min.size(); //ProposalBounds checks they're the same - return s; - } - }; - - class ServerWrapper + std::size_t ndims; + std::size_t nstacks; + + std::size_t ntemps; + std::size_t nsamples; + std::size_t swapInterval; + std::size_t loggingRateSec; + comms::JobType nJobTypes; + + bool useInitial; + Eigen::VectorXd initial; + + double optimalAcceptRate; + double optimalSwapRate; + + mcmc::ProposalBounds proposalBounds; + + std::size_t heartbeatTimeoutSec; + + std::string outputPath; + + static StatelineSettings fromJSON(const nlohmann::json& j) { + StatelineSettings s; + readFields(j, "nStacks", s.nstacks); + readFields(j, "nTemperatures", s.ntemps); + readFields(j, "nSamplesTotal", s.nsamples); + readFields(j, "swapInterval", s.swapInterval); + readFields(j, "loggingRateSec", s.loggingRateSec); + readFields(j, "nJobTypes", s.nJobTypes); + readFields(j, "outputPath", s.outputPath); + readFields(j, "optimalAcceptRate", s.optimalAcceptRate); + readFields(j, "optimalSwapRate", s.optimalSwapRate); + readFieldsWithDefault(j, "useInitial", s.useInitial, false); + + if (s.useInitial) + { + std::vector initial; + readFields(j, "initial", initial); + + s.initial.resize(initial.size()); + for (std::size_t i = 0; i < initial.size(); i++) + s.initial(i) = initial[i]; + } + + readFieldsWithDefault(j, "heartbeatTimeoutSec", s.heartbeatTimeoutSec, 15); + + s.proposalBounds = mcmc::ProposalBoundsFromJSON(j); + s.ndims = s.proposalBounds.min.size(); //ProposalBounds checks they're the same + return s; + } +}; + +class ServerWrapper +{ +public: + ServerWrapper(int port, const StatelineSettings& s); + ~ServerWrapper(); + + void start(); + void stop(); + + bool isRunning() const; + +private: + StatelineSettings settings_; + bool running_; + zmq::context_t context_; + comms::Delegator delegator_; + std::future serverThread_; + std::future samplerThread_; +}; - public: - ServerWrapper(uint port, const StatelineSettings& s); - ~ServerWrapper(); - void start(); - void stop(); - bool isRunning(); - - private: - StatelineSettings settings_; - bool running_; - zmq::context_t* context_; - ApiResources api_; - comms::Delegator delegator_; - std::future serverThread_; - std::future samplerThread_; - std::future apiServerThread_; - }; } diff --git a/src/bin/CMakeLists.txt b/src/bin/CMakeLists.txt index d2a46fa..7203d2d 100644 --- a/src/bin/CMakeLists.txt +++ b/src/bin/CMakeLists.txt @@ -6,8 +6,8 @@ # Date: 2014 # Macro for adding CPP binaries -FUNCTION(ADD_BINARY name library) - ADD_EXECUTABLE (${name} ${name}.cpp) +FUNCTION(ADD_BINARY fname name library) + ADD_EXECUTABLE(${name} ${fname}) SET_TARGET_PROPERTIES(${name} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${STATELINE_BINARY_DIR}) @@ -22,9 +22,5 @@ FUNCTION(COPY_FILE name) ENDIF() ENDFUNCTION() -# no point building this until we have a need for it -#ADD_BINARY(stateline-server statelineserver) - -#ADD_BINARY(stateline-client statelineclient) -#ADD_BINARY(stateline statelineserver) -ADD_BINARY(agent statelineclient) +ADD_BINARY(server.cpp sl-server stateline-server) +ADD_BINARY(agent.cpp sl-agent stateline-client) diff --git a/src/bin/agent.cpp b/src/bin/agent.cpp index 8881adf..bd7731c 100644 --- a/src/bin/agent.cpp +++ b/src/bin/agent.cpp @@ -35,7 +35,8 @@ int main(int argc, const char *argv[]) { // Parse the command line auto opt = commandLineOptions(); - opt.parse(argc, argv); + if (!sl::parseCommandLine(opt, argc, argv)) + return 0; // Initialise logging int logLevel; @@ -46,7 +47,7 @@ int main(int argc, const char *argv[]) std::string networkAddr, bindAddr; opt.get("-a")->getString(bindAddr); opt.get("-n")->getString(networkAddr); - sl::comms::AgentSettings settings{bindAddr, networkAddr}; + sl::comms::AgentSettings settings{bindAddr, "tcp://" + networkAddr}; zmq::context_t ctx{1}; sl::comms::Agent agent{ctx, settings}; diff --git a/src/bin/demo-config.json b/src/bin/config.default.json similarity index 100% rename from src/bin/demo-config.json rename to src/bin/config.default.json diff --git a/src/bin/demo-worker.py b/src/bin/demo-worker.py deleted file mode 100644 index 4b391bb..0000000 --- a/src/bin/demo-worker.py +++ /dev/null @@ -1,85 +0,0 @@ -import zmq -import json -import logging -import numpy as np -import subprocess -import random -import string - -HELLO = b'0' -HEARTBEAT = b'1' -REQUEST = b'2' -JOB = b'3' -RESULT = b'4' -GOODBYE = b'5' - -def random_string(): - return "".join(random.choice(string.lowercase) for x in range(10)) - -def nll(x): - # negative log likelihood of standard normal distribution - return 0.5 * x.dot(x) - -def handle_job(job_type, job_data): - sample = list(map(float, job_data.split(b':'))) - return nll(np.asarray(sample)) - -def send_hello(socket, nJobTypes): - - # job range in this case 0-nJobs (inclusive) - jobTypesStr = '0:{}'.format(nJobTypes).encode('ascii') - - logging.info("Sending HELLO message...") - socket.send_multipart([b"", HELLO, jobTypesStr]) - -def job_loop(socket): - while True: - logging.info("Getting job...") - r = socket.recv_multipart() - logging.info("Got job!") - - assert len(r) == 5 - - subject, job_type, job_id, job_data = r[1:] - - assert subject == JOB - - result = handle_job(job_type, job_data) - - logging.info("Sending result...") - rmsg = [b"", RESULT, job_id, str(result).encode('ascii')] - socket.send_multipart(rmsg) - logging.info("Sent result {0}!".format(job_id)) - -def main(): - # Initiate logging - #logging.basicConfig(level=logging.DEBUG) - logging.basicConfig(level=logging.CRITICAL) - - # Launch stateline-client - #random address - addr = "ipc:///tmp/sl_worker_" + random_string() + ".socket" - - logging.info('Starting client') - client_proc = subprocess.Popen(['./stateline-client', '-w', addr]) - logging.info('Started client') - - # Load configuration - with open('demo-config.json', 'r') as f: - config = json.load(f) - - nJobTypes = config['nJobTypes'] - - # Start minion - ctx = zmq.Context() - socket = ctx.socket(zmq.DEALER) - - logging.info("Connecting to {0}...".format(addr)) - socket.connect(addr) - logging.info("Connected!") - - send_hello(socket, nJobTypes) - job_loop(socket) - -if __name__ == "__main__": - main() diff --git a/src/bin/stateline.cpp b/src/bin/server.cpp similarity index 72% rename from src/bin/stateline.cpp rename to src/bin/server.cpp index 6cc0e5b..74f1b07 100644 --- a/src/bin/stateline.cpp +++ b/src/bin/server.cpp @@ -1,7 +1,6 @@ +//! Runs the MCMC and delegator. //! -//! A demo using Stateline to sample from a Gaussian mixture. -//! -//! \file stateline.cpp +//! \file src/bin/server.cpp //! \author Lachlan McCalman //! \author Darren Shen //! \date 2014 @@ -10,18 +9,15 @@ //! #include + #include "ezoptionparser/ezOptionParser.hpp" -#include "../app/serverwrapper.hpp" -#include "../app/logging.hpp" -#include "../app/serial.hpp" -#include "../app/signal.hpp" -#include "../app/commandline.hpp" +#include "app/serverwrapper.hpp" +#include "app/logging.hpp" +#include "app/signal.hpp" +#include "app/commandline.hpp" -// Alias namespaces for conciseness namespace sl = stateline; -namespace ph = std::placeholders; -namespace ch = std::chrono; using json = nlohmann::json; ez::ezOptionParser commandLineOptions() @@ -61,30 +57,23 @@ int main(int argc, const char *argv[]) opt.get("-l")->getInt(logLevel); sl::initLogging(logLevel); - // Capture Ctrl+C - sl::init::initialiseSignalHandler(); - std::string configPath; opt.get("-c")->getString(configPath); - json config = initConfig(configPath); + const auto config = initConfig(configPath); sl::StatelineSettings settings = sl::StatelineSettings::fromJSON(config); int port; opt.get("-p")->getInt(port); - sl::ServerWrapper s(port, settings); + sl::ServerWrapper s{port, settings}; s.start(); - while(!sl::global::interruptedBySignal && s.isRunning()) + while(s.isRunning()) { std::this_thread::sleep_for(std::chrono::milliseconds(500)); } s.stop(); - // Load the chains here from CSV? - return 0; - - } diff --git a/src/bin/stateline-server.cpp b/src/bin/stateline-server.cpp deleted file mode 100644 index f15d888..0000000 --- a/src/bin/stateline-server.cpp +++ /dev/null @@ -1,83 +0,0 @@ -//! -//! A demo using Stateline to sample from a Gaussian mixture. -//! -//! This file aims to be a tutorial on setting up a MCMC simulation using -//! the C++ server API of Stateline. -//! -//! \file demoDelegator.cpp -//! \author Lachlan McCalman -//! \author Darren Shen -//! \date 2014 -//! \licence Lesser General Public License version 3 or later -//! \copyright (c) 2014, NICTA -//! - -#include -#include -#include -#include - -#include - -#include "../app/logging.hpp" -#include "../app/serial.hpp" -#include "../app/signal.hpp" -#include "../app/commandline.hpp" -#include "../comms/delegator.hpp" -#include "../comms/thread.hpp" - -// Alias namespaces for conciseness -namespace sl = stateline; -namespace ph = std::placeholders; -namespace po = boost::program_options; -namespace ch = std::chrono; - -po::options_description commandLineOptions() -{ - auto opts = po::options_description("Demo Options"); - opts.add_options() - ("help,h", "Print help message") - ("loglevel,l", po::value()->default_value(0), "Logging level") - ("port,p",po::value()->default_value(5555), "Port on which to accept worker connections") - ; - return opts; -} - -int main(int ac, char *av[]) -{ - // -------------------------------------------------------------------------- - // Settings for the demo - // -------------------------------------------------------------------------- - - po::variables_map vm = sl::parseCommandLine(ac, av, commandLineOptions()); - - // This allows the user to interrupt the MCMC using Ctrl-C. - sl::init::initialiseSignalHandler(); - - // Initialise the logging settings - sl::initLogging("server", vm["loglevel"].as(), true, ""); - - uint port = vm["port"].as(); - auto settings = sl::comms::DelegatorSettings::Default(port); - settings.heartbeat.msRate = 100000; - settings.heartbeat.msTimeout = 200000; - zmq::context_t* context = new zmq::context_t(1); - LOG(INFO) << "\033[1;31mstarting delegator in thread\033[0m"; - bool running = true; - auto future = sl::startInThread(running, std::ref(*context), std::cref(settings)); - //sl::comms::Delegator delegator(context, settings); - //delegator.start(); - LOG(INFO) << "started delegator in thread"; - - while(!sl::global::interruptedBySignal) - { - std::this_thread::sleep_for(ch::milliseconds(500)); - } - - running = false; - delete context; - - future.wait(); - - return 0; -} diff --git a/src/bin/vis.py b/src/bin/vis.py deleted file mode 100644 index ba2d549..0000000 --- a/src/bin/vis.py +++ /dev/null @@ -1,20 +0,0 @@ -import matplotlib.pyplot as plt -import numpy as np -import csv -import sys - -samples = [] -with open(sys.argv[1], 'r') as csvfile: - reader = csv.reader(csvfile) - for row in reader: - samples.append(row[:-5]) - -ndims = len(samples[0]) -if ndims > 1: - import corner - - corner.corner(np.asarray(samples, dtype=float)) - plt.show() -else: - plt.hist(np.asarray(samples, dtype=float).ravel()) - plt.show() diff --git a/src/comms/agent.cpp b/src/comms/agent.cpp index 94e8dfd..c19f62c 100644 --- a/src/comms/agent.cpp +++ b/src/comms/agent.cpp @@ -41,7 +41,16 @@ struct Agent::WorkerEndpoint : Endpoint void onHello(const Message& m) { - agent.network.send(m); // Forward to delegator + // Worker HELLOs do not have heartbeat timeout information. + // It is our job to append that to the message. + Message copy = m; + Packer p{copy.data}; + p.reserve(m.data.size() + 4); + p.value(static_cast(timeout.count())); + + agent.network.send(copy); // Forward to delegator + + std::cout << "Forwarding HELLO" << std::endl; } void onResult(const Message& m) @@ -102,9 +111,11 @@ Agent::Agent(zmq::context_t& ctx, const AgentSettings& settings) , state_{worker_, network_} { // Initialise the local sockets + LOG(INFO) << "Agent binding to " << settings.bindAddress; worker_.bind(settings.bindAddress); + + LOG(INFO) << "Agent connecting to delegator at " << settings.networkAddress; network_.setIdentity(); - LOG(INFO) << "Worker connecting to " << settings.networkAddress; network_.connect(settings.networkAddress); } diff --git a/src/comms/delegator.cpp b/src/comms/delegator.cpp index 29b1ec7..2287875 100644 --- a/src/comms/delegator.cpp +++ b/src/comms/delegator.cpp @@ -58,7 +58,8 @@ void Delegator::State::addWorker(const std::string& address, const std::pair data) diff --git a/src/comms/delegator.hpp b/src/comms/delegator.hpp index 3861e05..43b8b47 100644 --- a/src/comms/delegator.hpp +++ b/src/comms/delegator.hpp @@ -43,6 +43,8 @@ class Delegator void start(bool& running); + const DelegatorSettings& settings() const { return state_.settings; } + private: using Clock = std::chrono::high_resolution_clock; diff --git a/src/comms/router.hpp b/src/comms/router.hpp index d5d6d33..f87105a 100644 --- a/src/comms/router.hpp +++ b/src/comms/router.hpp @@ -76,16 +76,17 @@ class Router template void poll(const IdleCallback& callback) { + LOG(DEBUG) << "Polling"; zmq::poll(pollList_.data(), pollList_.size(), pollWaitTime()); // Handle each poll event - meta::enumerateAll(endpoints_, [&pollList = pollList_](const auto i, auto& endpoint) + meta::enumerateAll(endpoints_, [&pollList = pollList_, &name = name_](const auto i, auto& endpoint) { bool newMsg = pollList[i].revents & ZMQ_POLLIN; if (newMsg) { - //TODO LOG(INFO) << "Router " << name_ << " received new message from endpoint " - //<< endpoint.socket().name(); + LOG(DEBUG) << "Router " << name << " received new message from endpoint " + << endpoint.socket().name(); endpoint.accept(); } diff --git a/src/comms/socket.cpp b/src/comms/socket.cpp index fcf9df1..582f9df 100644 --- a/src/comms/socket.cpp +++ b/src/comms/socket.cpp @@ -35,9 +35,9 @@ void SocketBase::bind(const std::string& address) { socket_.bind(address.c_str()); } - catch(...) + catch(const zmq::error_t& err) { - LOG(FATAL) << "Could not bind to " << address << ". Address already in use"; + LOG(FATAL) << "Socket '" << name() << "' could not bind to " << address << ". error='" << err.what() << "'"; } } diff --git a/src/infer/adaptive.cpp b/src/infer/adaptive.cpp index 62c5b7e..8b5ed11 100644 --- a/src/infer/adaptive.cpp +++ b/src/infer/adaptive.cpp @@ -11,7 +11,7 @@ #include "infer/adaptive.hpp" #include -#include "../app/jsonsettings.hpp" +#include "../app/json.hpp" #include #include #include diff --git a/src/infer/logging.cpp b/src/infer/logging.cpp index 9598afc..0212058 100644 --- a/src/infer/logging.cpp +++ b/src/infer/logging.cpp @@ -86,28 +86,5 @@ namespace stateline } } - void TableLogger::updateApi(ApiResources& res, const ChainArray& chains) - { - res.set("config", json({ - { "stacks", chains.numStacks() }, - { "chainsPerStack", chains.numTemps() } - })); - - json result; - for (uint i = 0; i < lengths_.size(); i++) - { - result.push_back(json({ - { "id", i }, - { "length", lengths_[i] }, - { "energy", energies_[i] }, - { "minEnergy", minEnergies_[i] }, - { "sigma", chains.sigma(i) }, - { "acceptRate", nAcceptsGlobal_[i] / (double)lengths_[i] }, - { "beta", chains.beta(i) }, - { "swapRate", nSwapsGlobal_[i] / (double)nSwapAttemptsGlobal_[i] } - })); - } - res.set("chains", result); - } } // namespace mcmc } // namespace stateline diff --git a/src/infer/logging.hpp b/src/infer/logging.hpp index e1e870a..508ee33 100644 --- a/src/infer/logging.hpp +++ b/src/infer/logging.hpp @@ -14,7 +14,6 @@ #include #include -#include "../app/api.hpp" #include "../infer/datatypes.hpp" #include "../infer/diagnostics.hpp" #include "../infer/chainarray.hpp" @@ -36,8 +35,6 @@ namespace stateline const std::vector& betas, const std::vector& swapRates); - void updateApi(ApiResources& res, const ChainArray& array); - private: ch::steady_clock::time_point lastPrintTime_; uint msRefresh_; diff --git a/src/infer/sampler.hpp b/src/infer/sampler.hpp index b3348b5..1a72269 100644 --- a/src/infer/sampler.hpp +++ b/src/infer/sampler.hpp @@ -15,9 +15,8 @@ #include "../infer/datatypes.hpp" #include "../infer/adaptive.hpp" #include "../infer/chainarray.hpp" -#include "../app/jsonsettings.hpp" +#include "../app/json.hpp" -#include #include namespace stateline @@ -31,31 +30,27 @@ namespace stateline //! Settings for the defining a hard boundary on the samples produced //! by the proposal function. + // TODO: this should not be here. static ProposalBounds ProposalBoundsFromJSON(const nlohmann::json& j) { - ProposalBounds b; - std::vector vmin = readSettings>(j, "min"); - std::vector vmax = readSettings>(j, "max"); + std::vector vmin, vmax; + readFields(j, "min", vmin); + readFields(j, "max", vmax); - uint nMin = vmin.size(); - uint nMax = vmax.size(); - if (nMin != nMax) + if (vmin.size() != vmax.size()) { LOG(FATAL) << "Proposal bounds dimension mismatch: nMin=" - << nMin << ", nMax=" << nMax; + << vmin.size() << ", nMax=" << vmax.size(); } - else + + ProposalBounds b; + b.min.resize(vmin.size()); + b.max.resize(vmax.size()); + for (std::size_t i = 0; i < vmin.size(); i++) { - uint nDims = nMax; - b.min.resize(nDims); - b.max.resize(nDims); - for (uint i=0; i < nDims; ++i) - { - b.min[i] = vmin[i]; - b.max[i] = vmax[i]; - } + b.min(i) = vmin[i]; + b.max(i) = vmax[i]; } - return b; } diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt index c8da340..1762a18 100644 --- a/src/test/CMakeLists.txt +++ b/src/test/CMakeLists.txt @@ -27,4 +27,4 @@ ADD_EXECUTABLE(${test_suite_name} EXCLUDE_FROM_ALL # chainarray.cpp db.cpp ) -TARGET_LINK_LIBRARIES(${test_suite_name} ${ZMQ_LIBRARY} statelineclient stateline-server) +TARGET_LINK_LIBRARIES(${test_suite_name} ${ZMQ_LIBRARY} stateline-client stateline-server) diff --git a/src/test/agent.cpp b/src/test/agent.cpp index 0c24396..9502739 100644 --- a/src/test/agent.cpp +++ b/src/test/agent.cpp @@ -17,6 +17,20 @@ using namespace stateline::comms; using namespace std::chrono_literals; +// Special HELLO sent from the worker +struct WorkerHello +{ + std::pair jobTypesRange; + + template + void pack(Pack& p) + { + p.reserve(4 + 4); + p.value(jobTypesRange.first); + p.value(jobTypesRange.second); + } +}; + TEST_CASE("agent can connect to network and worker", "[agent]") { zmq::context_t ctx{1}; @@ -35,11 +49,10 @@ TEST_CASE("agent can connect to network and worker", "[agent]") SECTION("forwards HELLO from worker to network") { { - protocol::Hello hello; + WorkerHello hello; hello.jobTypesRange = std::make_pair(1, 3); - hello.hbTimeoutSecs = 10; - REQUIRE(worker.send({"", HELLO, serialise(hello)}) == true); + REQUIRE(worker.send({"", HELLO, protocol::serialise(hello)}) == true); } agent.poll(); @@ -64,7 +77,7 @@ TEST_CASE("agent can connect to network and worker", "[agent]") REQUIRE(network.send({ agentAddress, WELCOME, serialise(welcome) }) == true); agent.poll(); - // TODO: + // TODO: check heartbeats SECTION("forwards JOB from network to worker") { From 6e208eed244a6f9185ec07f5ab95a5275c4c8357 Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Fri, 29 Jul 2016 12:02:14 +1000 Subject: [PATCH 21/28] Working MCMC --- src/app/logging.cpp | 90 +++++++++++++++++++++++++++-------------- src/app/logging.hpp | 8 ++-- src/bin/agent.cpp | 6 +-- src/bin/server.cpp | 6 +-- src/common/logging.hpp | 85 ++++++++++++++++++++++++++++++++++++++ src/comms/agent.cpp | 13 +++--- src/comms/delegator.cpp | 41 +++++++------------ src/comms/delegator.hpp | 2 +- src/comms/endpoint.hpp | 9 +++++ src/comms/heartbeat.cpp | 18 ++++++--- src/comms/router.hpp | 12 +++--- src/comms/socket.cpp | 15 ++++--- 12 files changed, 212 insertions(+), 93 deletions(-) create mode 100644 src/common/logging.hpp diff --git a/src/app/logging.cpp b/src/app/logging.cpp index b2adf8d..3946f40 100644 --- a/src/app/logging.cpp +++ b/src/app/logging.cpp @@ -20,37 +20,65 @@ // Don't want to get annoying crash messages when we ctrl-c INITIALIZE_EASYLOGGINGPP -namespace stateline +namespace stateline { + +namespace { + +int logLevelToInt(const std::string& logLevel) { - void initLogging(int logLevel, bool stdOut, const std::string& filename) - { - int normLog = logLevel; - int vLevel = 0; - if (logLevel < 0) - { - vLevel = -logLevel; - normLog = 0; - } - - el::Configurations defaultConf; - defaultConf.setToDefault(); - - defaultConf.setGlobally( - el::ConfigurationType::Format, "%datetime [%level] %msg"); - defaultConf.setGlobally( - el::ConfigurationType::ToStandardOutput, stdOut ? "true" : "false"); - defaultConf.setGlobally( - el::ConfigurationType::ToFile, stdOut ? "false" : "true"); - defaultConf.setGlobally( - el::ConfigurationType::Filename, filename); - - // TODO: currently only verbose logging works. Normal hierarchical logging - // is a bit tricky on easylogging. Will implement if needed. - el::Loggers::setVerboseLevel(vLevel); - - el::Loggers::reconfigureLogger("default", defaultConf); - - LOG(INFO) << "Logging initialised with level " << normLog << " and verbosity " << vLevel; - } + if (logLevel == "INFO") + return 1; + if (logLevel == "DEBUG") + return 2; + if (logLevel == "TRACE") + return 3; + else + return 0; +} + +} + +void initLogging(const std::string& logLevel, bool stdOut, const std::string& filename) +{ + el::Configurations defaultConf; + defaultConf.setToDefault(); + + defaultConf.setGlobally( + el::ConfigurationType::Format, "%datetime [%level] %fbase:%line: %msg"); + defaultConf.setGlobally( + el::ConfigurationType::ToStandardOutput, stdOut ? "true" : "false"); + defaultConf.setGlobally( + el::ConfigurationType::ToFile, stdOut ? "false" : "true"); + defaultConf.setGlobally( + el::ConfigurationType::Filename, filename); + defaultConf.setGlobally( + el::ConfigurationType::Enabled, "false"); // Disable all logs first + + defaultConf.set(el::Level::Info, + el::ConfigurationType::Format, "%datetime [%level] %msg"); // No need for file names on INFO logs + + defaultConf.set(el::Level::Error, + el::ConfigurationType::Enabled, "true"); + defaultConf.set(el::Level::Warning, + el::ConfigurationType::Enabled, "true"); + + const auto logLevelInt = logLevelToInt(logLevel); + + if (logLevelInt >= 1) + defaultConf.set(el::Level::Info, + el::ConfigurationType::Enabled, "true"); + + if (logLevelInt >= 2) + defaultConf.set(el::Level::Debug, + el::ConfigurationType::Enabled, "true"); + + if (logLevelInt >= 3) + defaultConf.set(el::Level::Trace, + el::ConfigurationType::Enabled, "true"); + + el::Loggers::reconfigureLogger("default", defaultConf); + + LOG(INFO) << "Logging initialised with level " << logLevel; +} } // namespace stateline diff --git a/src/app/logging.hpp b/src/app/logging.hpp index a3a71c9..4aaab86 100644 --- a/src/app/logging.hpp +++ b/src/app/logging.hpp @@ -1,7 +1,7 @@ //! //! Helper functions for setting up logging. //! -//! \file app/console.hpp +//! \file app/logging.hpp //! \author Lachlan McCalman //! \date 2014 //! \license Lesser General Public License version 3 or later @@ -16,12 +16,10 @@ namespace stateline { //! Initialise the logging system // - //! \param appName The name of the executable - //! \param logLevel The numerical level of logging. <0 gets increasingly - //! verbose for debugging. 0 is release logging, and >0 is + //! \param logLevel The level of logging. Can be TEST, INFO, DEBUG, TRACE. //! increasingly quiet. //! \param stdErr Switch to enable logging to stdError. //! \param directory The directory to log to if stdErr logging is disabled. //! - void initLogging(int logLevel, bool stdOut=true, const std::string& filename="."); + void initLogging(const std::string& logLevel, bool stdOut=true, const std::string& filename="."); } // namespace stateline diff --git a/src/bin/agent.cpp b/src/bin/agent.cpp index bd7731c..4fd180a 100644 --- a/src/bin/agent.cpp +++ b/src/bin/agent.cpp @@ -25,7 +25,7 @@ ez::ezOptionParser commandLineOptions() ez::ezOptionParser opt; opt.overview = "Stateline agent options"; opt.add("", 0, 0, 0, "Print help message", "-h", "--help"); - opt.add("0", 0, 1, 0, "Logging level", "-l", "--log-level"); + opt.add("INFO", 0, 1, 0, "Logging level (INFO/DEBUG/TRACE)", "-l", "--log-level"); opt.add("localhost:5555", 0, 1, 0, "Address of delegator", "-n", "--network-addr"); opt.add("ipc:///tmp/sl_agent.sock", 0, 1, 0, "Address of agent for worker to connect to", "-a", "--agent-addr"); return opt; @@ -39,8 +39,8 @@ int main(int argc, const char *argv[]) return 0; // Initialise logging - int logLevel; - opt.get("-l")->getInt(logLevel); + std::string logLevel; + opt.get("-l")->getString(logLevel); sl::initLogging(logLevel); // Initialise the agent diff --git a/src/bin/server.cpp b/src/bin/server.cpp index 74f1b07..71b4696 100644 --- a/src/bin/server.cpp +++ b/src/bin/server.cpp @@ -25,7 +25,7 @@ ez::ezOptionParser commandLineOptions() ez::ezOptionParser opt; opt.overview = "Demo options"; opt.add("", 0, 0, 0, "Print help message", "-h", "--help"); - opt.add("0", 0, 1, 0, "Logging level", "-l", "--log-level"); + opt.add("INFO", 0, 1, 0, "Logging level (INFO/DEBUG/TRACE)", "-l", "--log-level"); opt.add("5555", 0, 1, 0, "Port on which to accept worker connections", "-p", "--port"); opt.add("config.json", 0, 1, 0, "Path to configuration file", "-c", "--config"); return opt; @@ -53,8 +53,8 @@ int main(int argc, const char *argv[]) return 0; // Initialise logging - int logLevel; - opt.get("-l")->getInt(logLevel); + std::string logLevel; + opt.get("-l")->getString(logLevel); sl::initLogging(logLevel); std::string configPath; diff --git a/src/common/logging.hpp b/src/common/logging.hpp new file mode 100644 index 0000000..bc9eb73 --- /dev/null +++ b/src/common/logging.hpp @@ -0,0 +1,85 @@ +//! Common interface to logging independent of the log system we use. +//! +//! \file src/comms/logging.hpp +//! \author Darren Shen +//! \date 2014 +//! \license Lesser General Public License version 3 or later +//! \copyright (c) 2014, NICTA +//! +#pragma once + +#include + +#include + +namespace stateline { + +#define SL_LOG(level) LOG(level) +#define SL_CLOG(level, logger) CLOG(level, logger) + +namespace detail { + +inline void pprintVal(std::ostringstream& s, const std::string& val) +{ + // Print string wrapped in quotes + s << '"' << val << '"'; +} + +template +void pprintVal(std::ostringstream& s, const T& val) +{ + // Use the stringstream default format + s << val; +} + +template +void pprintVal(std::ostringstream& s, const std::pair& val) +{ + s << "("; + pprintVal(s, val.first); + s << ", "; + pprintVal(s, val.second); +} + +inline void pprintVal(std::ostringstream& s, const std::chrono::milliseconds& val) +{ + pprintVal(s, val.count()); + s << "ms"; +} + +inline void pprintVal(std::ostringstream& s, const std::chrono::seconds& val) +{ + pprintVal(s, val.count()); + s << "s"; +} + +template +inline void pprintImpl(std::ostringstream&) +{ + // Base case +} + +template +void pprintImpl(std::ostringstream& s, const std::string& key, const T& val, Args&&... args) +{ + if (!First) + s << ", "; + s << key << "="; + + pprintVal(s, val); + pprintImpl(s, std::forward(args)...); +} + +} + +template +std::string pprint(Args&&... args) +{ + std::ostringstream ss; + ss << "["; + detail::pprintImpl(ss, std::forward(args)...); + ss << "]"; + return ss.str(); +} + +} diff --git a/src/comms/agent.cpp b/src/comms/agent.cpp index c19f62c..2685252 100644 --- a/src/comms/agent.cpp +++ b/src/comms/agent.cpp @@ -10,14 +10,13 @@ #include "comms/agent.hpp" +#include "common/logging.hpp" #include "comms/endpoint.hpp" #include "comms/router.hpp" #include "comms/protocol.hpp" #include -#include - namespace stateline { namespace comms { Agent::State::State(Socket& worker, Socket& network) @@ -48,14 +47,12 @@ struct Agent::WorkerEndpoint : Endpoint p.reserve(m.data.size() + 4); p.value(static_cast(timeout.count())); - agent.network.send(copy); // Forward to delegator - - std::cout << "Forwarding HELLO" << std::endl; + forwardMessage(agent.network, copy); } void onResult(const Message& m) { - agent.network.send(m); // Forward result to delegator + forwardMessage(agent.network, m); if (agent.queue.empty()) { @@ -82,14 +79,14 @@ struct Agent::NetworkEndpoint : Endpoint void onWelcome(const Message& m) { const auto welcome = protocol::unserialise(m.data); - agent.network.startHeartbeats(m.address, std::chrono::seconds{welcome.hbTimeoutSecs}); + agent.network.startHeartbeats("delegator", std::chrono::seconds{welcome.hbTimeoutSecs}); } void onJob(const Message& m) { if (agent.workerWaiting) { - agent.worker.send(m); // Forward job to worker + forwardMessage(agent.worker, m); agent.workerWaiting = false; } else diff --git a/src/comms/delegator.cpp b/src/comms/delegator.cpp index 2287875..4b5d6ef 100644 --- a/src/comms/delegator.cpp +++ b/src/comms/delegator.cpp @@ -8,6 +8,7 @@ #include "comms/delegator.hpp" +#include "common/logging.hpp" #include "comms/datatypes.hpp" #include "comms/endpoint.hpp" #include "comms/protocol.hpp" @@ -15,7 +16,6 @@ #include -#include #include namespace stateline { namespace comms { @@ -46,8 +46,15 @@ Delegator::State::State(zmq::context_t& ctx, const DelegatorSettings& settings) { } -void Delegator::State::addWorker(const std::string& address, const std::pair& jobTypesRange) +void Delegator::State::addWorker(const std::string& address, std::pair jobTypesRange) { + // 0 is a special job type indicating a wildcard + if (jobTypesRange.first == 0) + jobTypesRange.first = 1; + + if (jobTypesRange.second == 0) + jobTypesRange.second = settings.numJobTypes; + Worker w{address, jobTypesRange}; // TODO: why not create lazily? @@ -58,8 +65,8 @@ void Delegator::State::addWorker(const std::string& address, const std::pair data) @@ -75,7 +82,7 @@ void Delegator::State::addBatch(const std::string& address, JobID id, std::vecto jobQueue.emplace_back(ret.first, i + 1); } - VLOG(2) << pending.size() << " requests pending"; + SL_LOG(DEBUG) << pending.size() << " requests pending"; } Delegator::Worker* Delegator::State::bestWorker(const JobType type) @@ -86,7 +93,7 @@ Delegator::Worker* Delegator::State::bestWorker(const JobType type) { auto& worker = it.second; if (type >= worker.jobTypesRange.first && - type <= worker.jobTypesRange.second && + type <= worker.jobTypesRange.second && worker.inProgress.size() < worker.maxJobs) { const auto duration = worker.estimatedFinishDurationForNewJob(type); @@ -115,7 +122,6 @@ struct Delegator::RequesterEndpoint : Endpoint void onBatchJob(const Message& m) { auto batchJob = protocol::unserialise(m.data); - VLOG(2) << "Received batch"; delegator.addBatch(m.address, batchJob.id, std::move(batchJob.data)); } @@ -154,7 +160,6 @@ struct Delegator::NetworkEndpoint : Endpoint { for (auto it = delegator.jobQueue.begin(); it != delegator.jobQueue.end(); ) { - // TODO: find the best worker Worker *worker = delegator.bestWorker(it->type); if (!worker) { @@ -166,7 +171,7 @@ struct Delegator::NetworkEndpoint : Endpoint job.id = ++lastJobID; job.data = it->batch->second.data; - delegator.network.send({worker->address, JOB, serialise(job)}); + forwardMessage(delegator.network, {worker->address, JOB, serialise(job)}); it->startTime = Clock::now(); worker->inProgress.emplace(job.id, std::move(*it)); @@ -206,24 +211,6 @@ struct Delegator::NetworkEndpoint : Endpoint // Remove job from work in progress store worker.inProgress.erase(result.id); } - - /* - void onBye(const Message& m) { hb.disconnect(m.address); } - - void onAny(const Message& m) { hb.update(m.address); } -}; - - // TODO: could we compute these lazily? i.e. each time a new job is assigned, - // we update the expected finishing time? - uint usTillDone(const Delegator::Worker& w, uint jobType) - { - uint t = 0; - for (auto const& i : w.workInProgress) - t += timeForJob(w, i.second.type); - //now add the expected time for the new job - t += timeForJob(w, jobType); - return t; - }*/ }; Delegator::Delegator(zmq::context_t& ctx, const DelegatorSettings& settings) diff --git a/src/comms/delegator.hpp b/src/comms/delegator.hpp index 43b8b47..87a44f7 100644 --- a/src/comms/delegator.hpp +++ b/src/comms/delegator.hpp @@ -104,7 +104,7 @@ class Delegator State(zmq::context_t& ctx, const DelegatorSettings& settings); - void addWorker(const std::string& address, const std::pair& jobTypeRange); + void addWorker(const std::string& address, std::pair jobTypeRange); void addBatch(const std::string& address, JobID id, std::vector data); diff --git a/src/comms/endpoint.hpp b/src/comms/endpoint.hpp index c52944a..0bf2d7e 100644 --- a/src/comms/endpoint.hpp +++ b/src/comms/endpoint.hpp @@ -9,6 +9,7 @@ #pragma once +#include "common/logging.hpp" #include "comms/socket.hpp" namespace stateline { namespace comms { @@ -36,6 +37,8 @@ class Endpoint void handle(const Message& m) { + SL_LOG(DEBUG) << "Handling message " << pprint("msg", m); + switch (m.subject) { case HEARTBEAT: @@ -90,6 +93,12 @@ class Endpoint void onHeartbeatSend(const std::string& addr) { } void onHeartbeatTimeout(const std::string& addr) { } + void forwardMessage(Socket& s, const Message &m) + { + SL_LOG(DEBUG) << "Forwarding message to " << s.name() << " " << pprint("msg", m); + s.send(m); + } + void idle() { // handle heartbeats and disconnects diff --git a/src/comms/heartbeat.cpp b/src/comms/heartbeat.cpp index a27d732..9577aaf 100644 --- a/src/comms/heartbeat.cpp +++ b/src/comms/heartbeat.cpp @@ -10,7 +10,7 @@ #include "comms/heartbeat.hpp" -#include +#include "common/logging.hpp" namespace stateline { namespace comms { @@ -22,6 +22,8 @@ Heartbeat::Heartbeat() void Heartbeat::connect(const std::string& addr, std::chrono::seconds timeout) { + SL_LOG(INFO) << addr << " connected " << pprint("timeout", timeout); + // We send 2 heartbeats per timeout const auto interval = std::chrono::duration_cast(timeout) / 2; @@ -35,11 +37,11 @@ void Heartbeat::disconnect(const std::string& addr, DisconnectReason reason) switch (reason) { case DisconnectReason::USER_REQUESTED: - VLOG(1) << addr << " disconnected by request"; + SL_LOG(INFO) << addr << " disconnected by request"; break; case DisconnectReason::TIMEOUT: - VLOG(1) << addr << " disconnected by time out"; + SL_LOG(INFO) << addr << " disconnected by time out"; break; } @@ -49,6 +51,8 @@ void Heartbeat::disconnect(const std::string& addr, DisconnectReason reason) void Heartbeat::updateLastSendTime(const std::string& addr) { + SL_LOG(TRACE) << "Update last send time " << pprint("addr", addr); + auto it = conns_.find(addr); if (it == conns_.end()) return; @@ -58,6 +62,8 @@ void Heartbeat::updateLastSendTime(const std::string& addr) void Heartbeat::updateLastRecvTime(const std::string& addr) { + SL_LOG(TRACE) << "Update last receive time " << pprint("addr", addr); + auto it = conns_.find(addr); if (it == conns_.end()) return; @@ -67,6 +73,8 @@ void Heartbeat::updateLastRecvTime(const std::string& addr) void Heartbeat::idle() { + SL_LOG(TRACE) << "Heartbeat idle"; + const auto now = Clock::now(); // Send any outstanding heartbeats. @@ -86,7 +94,7 @@ void Heartbeat::idle() // Disconnect if they missed 2 heartbeat intervals. if (it->second.lastRecvTime + it->second.interval * 2 < now) { - VLOG(1) << it->first << " timed out"; + SL_LOG(INFO) << it->first << " disconnected by timeout " << pprint("timeout", it->second.interval * 2); disconnectCallback_(it->first, DisconnectReason::TIMEOUT); it = conns_.erase(it); } @@ -99,7 +107,7 @@ void Heartbeat::idle() void Heartbeat::sendHeartbeat(ConnMap::value_type& kv) { - VLOG(4) << "Sending HEARTBEAT to " << kv.first; + SL_LOG(TRACE) << "Calling heartbeat callback " << pprint("addr", kv.first); heartbeatCallback_(kv.first); kv.second.lastSendTime = Clock::now(); diff --git a/src/comms/router.hpp b/src/comms/router.hpp index f87105a..29b2be8 100644 --- a/src/comms/router.hpp +++ b/src/comms/router.hpp @@ -14,13 +14,13 @@ #pragma once #include "common/meta.hpp" +#include "common/logging.hpp" #include "comms/message.hpp" #include "comms/socket.hpp" #include #include #include -#include namespace stateline { namespace comms { @@ -76,8 +76,9 @@ class Router template void poll(const IdleCallback& callback) { - LOG(DEBUG) << "Polling"; - zmq::poll(pollList_.data(), pollList_.size(), pollWaitTime()); + const auto waitTime = pollWaitTime(); + SL_LOG(TRACE) << "Begin polling " << pprint("waitTime", waitTime); + zmq::poll(pollList_.data(), pollList_.size(), waitTime); // Handle each poll event meta::enumerateAll(endpoints_, [&pollList = pollList_, &name = name_](const auto i, auto& endpoint) @@ -85,13 +86,14 @@ class Router bool newMsg = pollList[i].revents & ZMQ_POLLIN; if (newMsg) { - LOG(DEBUG) << "Router " << name << " received new message from endpoint " - << endpoint.socket().name(); + SL_LOG(DEBUG) << "Router " << name << " received new message " + << pprint("endpoint", endpoint.socket().name()); endpoint.accept(); } }); + SL_LOG(TRACE) << "Finished polling. Calling idle callback..."; callback(); } diff --git a/src/comms/socket.cpp b/src/comms/socket.cpp index 582f9df..6f6aaae 100644 --- a/src/comms/socket.cpp +++ b/src/comms/socket.cpp @@ -10,9 +10,10 @@ #include "comms/socket.hpp" +#include "common/logging.hpp" + #include #include -#include #include namespace stateline { namespace comms { @@ -37,7 +38,8 @@ void SocketBase::bind(const std::string& address) } catch(const zmq::error_t& err) { - LOG(FATAL) << "Socket '" << name() << "' could not bind to " << address << ". error='" << err.what() << "'"; + LOG(FATAL) << "Socket '" << name() << "' could not bind to " << address << " " + << pprint("err", err.what()); } } @@ -53,8 +55,11 @@ bool SocketBase::send(const std::string& address, const std::string& data) hb_.updateLastSendTime(address); return true; } - catch(zmq::error_t) + catch(const zmq::error_t& err) { + LOG(ERROR) << "Socket '" << name() << "' could not send to " << address << " " + << pprint("err", err.what()); + // TODO: disconnect heartbeat immediately return false; } @@ -116,7 +121,7 @@ Socket::Socket(zmq::context_t& ctx, zmq::socket_type type, std::string name, int bool Socket::send(const Message& m) { - VLOG(5) << "Socket " << name() << " sending " << m; + SL_LOG(TRACE) << "Socket " << name() << " sending " << m; // Pack the subject and the data together std::string buffer(sizeof(Subject) + m.data.size(), ' '); @@ -136,7 +141,7 @@ Message Socket::recv() std::string data{msg.second.data() + sizeof(Subject), msg.second.data() + msg.second.size()}; Message m{msg.first, subject, std::move(data)}; - VLOG(5) << "Socket " << name() << " received " << m; + SL_LOG(TRACE) << "Socket " << name() << " received " << m; return m; } From 585a8e209dbb3fa0da264214a1eb20d505d2142a Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Fri, 29 Jul 2016 12:30:59 +1000 Subject: [PATCH 22/28] Remove frontend --- frontend/README.md | 3 - frontend/css/custom.css | 15 -- frontend/css/normalize.css | 427 ------------------------------------ frontend/css/skeleton.css | 418 ----------------------------------- frontend/images/favicon.png | Bin 1156 -> 0 bytes frontend/index.html | 139 ------------ frontend/js/chart.js | 75 ------- frontend/js/gradstop.min.js | 1 - 8 files changed, 1078 deletions(-) delete mode 100644 frontend/README.md delete mode 100644 frontend/css/custom.css delete mode 100644 frontend/css/normalize.css delete mode 100644 frontend/css/skeleton.css delete mode 100644 frontend/images/favicon.png delete mode 100644 frontend/index.html delete mode 100644 frontend/js/chart.js delete mode 100644 frontend/js/gradstop.min.js diff --git a/frontend/README.md b/frontend/README.md deleted file mode 100644 index a96ba3d..0000000 --- a/frontend/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Frontend - -Run stateline server and go to `http://localhost:8080/` in your browser. diff --git a/frontend/css/custom.css b/frontend/css/custom.css deleted file mode 100644 index 4c502e1..0000000 --- a/frontend/css/custom.css +++ /dev/null @@ -1,15 +0,0 @@ -.title { - text-align: center; -} - -.alert { - border: 1px solid #FF992E; - padding: 2rem; - margin: 2rem; - width: 100%; - color: #FF992E; -} - -.full-row { - margin-top: 2rem; -} diff --git a/frontend/css/normalize.css b/frontend/css/normalize.css deleted file mode 100644 index 81c6f31..0000000 --- a/frontend/css/normalize.css +++ /dev/null @@ -1,427 +0,0 @@ -/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ - -/** - * 1. Set default font family to sans-serif. - * 2. Prevent iOS text size adjust after orientation change, without disabling - * user zoom. - */ - -html { - font-family: sans-serif; /* 1 */ - -ms-text-size-adjust: 100%; /* 2 */ - -webkit-text-size-adjust: 100%; /* 2 */ -} - -/** - * Remove default margin. - */ - -body { - margin: 0; -} - -/* HTML5 display definitions - ========================================================================== */ - -/** - * Correct `block` display not defined for any HTML5 element in IE 8/9. - * Correct `block` display not defined for `details` or `summary` in IE 10/11 - * and Firefox. - * Correct `block` display not defined for `main` in IE 11. - */ - -article, -aside, -details, -figcaption, -figure, -footer, -header, -hgroup, -main, -menu, -nav, -section, -summary { - display: block; -} - -/** - * 1. Correct `inline-block` display not defined in IE 8/9. - * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. - */ - -audio, -canvas, -progress, -video { - display: inline-block; /* 1 */ - vertical-align: baseline; /* 2 */ -} - -/** - * Prevent modern browsers from displaying `audio` without controls. - * Remove excess height in iOS 5 devices. - */ - -audio:not([controls]) { - display: none; - height: 0; -} - -/** - * Address `[hidden]` styling not present in IE 8/9/10. - * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. - */ - -[hidden], -template { - display: none; -} - -/* Links - ========================================================================== */ - -/** - * Remove the gray background color from active links in IE 10. - */ - -a { - background-color: transparent; -} - -/** - * Improve readability when focused and also mouse hovered in all browsers. - */ - -a:active, -a:hover { - outline: 0; -} - -/* Text-level semantics - ========================================================================== */ - -/** - * Address styling not present in IE 8/9/10/11, Safari, and Chrome. - */ - -abbr[title] { - border-bottom: 1px dotted; -} - -/** - * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. - */ - -b, -strong { - font-weight: bold; -} - -/** - * Address styling not present in Safari and Chrome. - */ - -dfn { - font-style: italic; -} - -/** - * Address variable `h1` font-size and margin within `section` and `article` - * contexts in Firefox 4+, Safari, and Chrome. - */ - -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -/** - * Address styling not present in IE 8/9. - */ - -mark { - background: #ff0; - color: #000; -} - -/** - * Address inconsistent and variable font size in all browsers. - */ - -small { - font-size: 80%; -} - -/** - * Prevent `sub` and `sup` affecting `line-height` in all browsers. - */ - -sub, -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sup { - top: -0.5em; -} - -sub { - bottom: -0.25em; -} - -/* Embedded content - ========================================================================== */ - -/** - * Remove border when inside `a` element in IE 8/9/10. - */ - -img { - border: 0; -} - -/** - * Correct overflow not hidden in IE 9/10/11. - */ - -svg:not(:root) { - overflow: hidden; -} - -/* Grouping content - ========================================================================== */ - -/** - * Address margin not present in IE 8/9 and Safari. - */ - -figure { - margin: 1em 40px; -} - -/** - * Address differences between Firefox and other browsers. - */ - -hr { - -moz-box-sizing: content-box; - box-sizing: content-box; - height: 0; -} - -/** - * Contain overflow in all browsers. - */ - -pre { - overflow: auto; -} - -/** - * Address odd `em`-unit font size rendering in all browsers. - */ - -code, -kbd, -pre, -samp { - font-family: monospace, monospace; - font-size: 1em; -} - -/* Forms - ========================================================================== */ - -/** - * Known limitation: by default, Chrome and Safari on OS X allow very limited - * styling of `select`, unless a `border` property is set. - */ - -/** - * 1. Correct color not being inherited. - * Known issue: affects color of disabled elements. - * 2. Correct font properties not being inherited. - * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. - */ - -button, -input, -optgroup, -select, -textarea { - color: inherit; /* 1 */ - font: inherit; /* 2 */ - margin: 0; /* 3 */ -} - -/** - * Address `overflow` set to `hidden` in IE 8/9/10/11. - */ - -button { - overflow: visible; -} - -/** - * Address inconsistent `text-transform` inheritance for `button` and `select`. - * All other form control elements do not inherit `text-transform` values. - * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. - * Correct `select` style inheritance in Firefox. - */ - -button, -select { - text-transform: none; -} - -/** - * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` - * and `video` controls. - * 2. Correct inability to style clickable `input` types in iOS. - * 3. Improve usability and consistency of cursor style between image-type - * `input` and others. - */ - -button, -html input[type="button"], /* 1 */ -input[type="reset"], -input[type="submit"] { - -webkit-appearance: button; /* 2 */ - cursor: pointer; /* 3 */ -} - -/** - * Re-set default cursor for disabled elements. - */ - -button[disabled], -html input[disabled] { - cursor: default; -} - -/** - * Remove inner padding and border in Firefox 4+. - */ - -button::-moz-focus-inner, -input::-moz-focus-inner { - border: 0; - padding: 0; -} - -/** - * Address Firefox 4+ setting `line-height` on `input` using `!important` in - * the UA stylesheet. - */ - -input { - line-height: normal; -} - -/** - * It's recommended that you don't attempt to style these elements. - * Firefox's implementation doesn't respect box-sizing, padding, or width. - * - * 1. Address box sizing set to `content-box` in IE 8/9/10. - * 2. Remove excess padding in IE 8/9/10. - */ - -input[type="checkbox"], -input[type="radio"] { - box-sizing: border-box; /* 1 */ - padding: 0; /* 2 */ -} - -/** - * Fix the cursor style for Chrome's increment/decrement buttons. For certain - * `font-size` values of the `input`, it causes the cursor style of the - * decrement button to change from `default` to `text`. - */ - -input[type="number"]::-webkit-inner-spin-button, -input[type="number"]::-webkit-outer-spin-button { - height: auto; -} - -/** - * 1. Address `appearance` set to `searchfield` in Safari and Chrome. - * 2. Address `box-sizing` set to `border-box` in Safari and Chrome - * (include `-moz` to future-proof). - */ - -input[type="search"] { - -webkit-appearance: textfield; /* 1 */ - -moz-box-sizing: content-box; - -webkit-box-sizing: content-box; /* 2 */ - box-sizing: content-box; -} - -/** - * Remove inner padding and search cancel button in Safari and Chrome on OS X. - * Safari (but not Chrome) clips the cancel button when the search input has - * padding (and `textfield` appearance). - */ - -input[type="search"]::-webkit-search-cancel-button, -input[type="search"]::-webkit-search-decoration { - -webkit-appearance: none; -} - -/** - * Define consistent border, margin, and padding. - */ - -fieldset { - border: 1px solid #c0c0c0; - margin: 0 2px; - padding: 0.35em 0.625em 0.75em; -} - -/** - * 1. Correct `color` not being inherited in IE 8/9/10/11. - * 2. Remove padding so people aren't caught out if they zero out fieldsets. - */ - -legend { - border: 0; /* 1 */ - padding: 0; /* 2 */ -} - -/** - * Remove default vertical scrollbar in IE 8/9/10/11. - */ - -textarea { - overflow: auto; -} - -/** - * Don't inherit the `font-weight` (applied by a rule above). - * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. - */ - -optgroup { - font-weight: bold; -} - -/* Tables - ========================================================================== */ - -/** - * Remove most spacing between table cells. - */ - -table { - border-collapse: collapse; - border-spacing: 0; -} - -td, -th { - padding: 0; -} \ No newline at end of file diff --git a/frontend/css/skeleton.css b/frontend/css/skeleton.css deleted file mode 100644 index f28bf6c..0000000 --- a/frontend/css/skeleton.css +++ /dev/null @@ -1,418 +0,0 @@ -/* -* Skeleton V2.0.4 -* Copyright 2014, Dave Gamache -* www.getskeleton.com -* Free to use under the MIT license. -* http://www.opensource.org/licenses/mit-license.php -* 12/29/2014 -*/ - - -/* Table of contents -–––––––––––––––––––––––––––––––––––––––––––––––––– -- Grid -- Base Styles -- Typography -- Links -- Buttons -- Forms -- Lists -- Code -- Tables -- Spacing -- Utilities -- Clearing -- Media Queries -*/ - - -/* Grid -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -.container { - position: relative; - width: 100%; - max-width: 960px; - margin: 0 auto; - padding: 0 20px; - box-sizing: border-box; } -.column, -.columns { - width: 100%; - float: left; - box-sizing: border-box; } - -/* For devices larger than 400px */ -@media (min-width: 400px) { - .container { - width: 85%; - padding: 0; } -} - -/* For devices larger than 550px */ -@media (min-width: 550px) { - .container { - width: 80%; } - .column, - .columns { - margin-left: 4%; } - .column:first-child, - .columns:first-child { - margin-left: 0; } - - .one.column, - .one.columns { width: 4.66666666667%; } - .two.columns { width: 13.3333333333%; } - .three.columns { width: 22%; } - .four.columns { width: 30.6666666667%; } - .five.columns { width: 39.3333333333%; } - .six.columns { width: 48%; } - .seven.columns { width: 56.6666666667%; } - .eight.columns { width: 65.3333333333%; } - .nine.columns { width: 74.0%; } - .ten.columns { width: 82.6666666667%; } - .eleven.columns { width: 91.3333333333%; } - .twelve.columns { width: 100%; margin-left: 0; } - - .one-third.column { width: 30.6666666667%; } - .two-thirds.column { width: 65.3333333333%; } - - .one-half.column { width: 48%; } - - /* Offsets */ - .offset-by-one.column, - .offset-by-one.columns { margin-left: 8.66666666667%; } - .offset-by-two.column, - .offset-by-two.columns { margin-left: 17.3333333333%; } - .offset-by-three.column, - .offset-by-three.columns { margin-left: 26%; } - .offset-by-four.column, - .offset-by-four.columns { margin-left: 34.6666666667%; } - .offset-by-five.column, - .offset-by-five.columns { margin-left: 43.3333333333%; } - .offset-by-six.column, - .offset-by-six.columns { margin-left: 52%; } - .offset-by-seven.column, - .offset-by-seven.columns { margin-left: 60.6666666667%; } - .offset-by-eight.column, - .offset-by-eight.columns { margin-left: 69.3333333333%; } - .offset-by-nine.column, - .offset-by-nine.columns { margin-left: 78.0%; } - .offset-by-ten.column, - .offset-by-ten.columns { margin-left: 86.6666666667%; } - .offset-by-eleven.column, - .offset-by-eleven.columns { margin-left: 95.3333333333%; } - - .offset-by-one-third.column, - .offset-by-one-third.columns { margin-left: 34.6666666667%; } - .offset-by-two-thirds.column, - .offset-by-two-thirds.columns { margin-left: 69.3333333333%; } - - .offset-by-one-half.column, - .offset-by-one-half.columns { margin-left: 52%; } - -} - - -/* Base Styles -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -/* NOTE -html is set to 62.5% so that all the REM measurements throughout Skeleton -are based on 10px sizing. So basically 1.5rem = 15px :) */ -html { - font-size: 62.5%; } -body { - font-size: 1.5em; /* currently ems cause chrome bug misinterpreting rems on body element */ - line-height: 1.6; - font-weight: 400; - font-family: "Raleway", "HelveticaNeue", "Helvetica Neue", Helvetica, Arial, sans-serif; - color: #222; } - - -/* Typography -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -h1, h2, h3, h4, h5, h6 { - margin-top: 0; - margin-bottom: 2rem; - font-weight: 300; } -h1 { font-size: 4.0rem; line-height: 1.2; letter-spacing: -.1rem;} -h2 { font-size: 3.6rem; line-height: 1.25; letter-spacing: -.1rem; } -h3 { font-size: 3.0rem; line-height: 1.3; letter-spacing: -.1rem; } -h4 { font-size: 2.4rem; line-height: 1.35; letter-spacing: -.08rem; } -h5 { font-size: 1.8rem; line-height: 1.5; letter-spacing: -.05rem; } -h6 { font-size: 1.5rem; line-height: 1.6; letter-spacing: 0; } - -/* Larger than phablet */ -@media (min-width: 550px) { - h1 { font-size: 5.0rem; } - h2 { font-size: 4.2rem; } - h3 { font-size: 3.6rem; } - h4 { font-size: 3.0rem; } - h5 { font-size: 2.4rem; } - h6 { font-size: 1.5rem; } -} - -p { - margin-top: 0; } - - -/* Links -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -a { - color: #1EAEDB; } -a:hover { - color: #0FA0CE; } - - -/* Buttons -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -.button, -button, -input[type="submit"], -input[type="reset"], -input[type="button"] { - display: inline-block; - height: 38px; - padding: 0 30px; - color: #555; - text-align: center; - font-size: 11px; - font-weight: 600; - line-height: 38px; - letter-spacing: .1rem; - text-transform: uppercase; - text-decoration: none; - white-space: nowrap; - background-color: transparent; - border-radius: 4px; - border: 1px solid #bbb; - cursor: pointer; - box-sizing: border-box; } -.button:hover, -button:hover, -input[type="submit"]:hover, -input[type="reset"]:hover, -input[type="button"]:hover, -.button:focus, -button:focus, -input[type="submit"]:focus, -input[type="reset"]:focus, -input[type="button"]:focus { - color: #333; - border-color: #888; - outline: 0; } -.button.button-primary, -button.button-primary, -input[type="submit"].button-primary, -input[type="reset"].button-primary, -input[type="button"].button-primary { - color: #FFF; - background-color: #33C3F0; - border-color: #33C3F0; } -.button.button-primary:hover, -button.button-primary:hover, -input[type="submit"].button-primary:hover, -input[type="reset"].button-primary:hover, -input[type="button"].button-primary:hover, -.button.button-primary:focus, -button.button-primary:focus, -input[type="submit"].button-primary:focus, -input[type="reset"].button-primary:focus, -input[type="button"].button-primary:focus { - color: #FFF; - background-color: #1EAEDB; - border-color: #1EAEDB; } - - -/* Forms -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -input[type="email"], -input[type="number"], -input[type="search"], -input[type="text"], -input[type="tel"], -input[type="url"], -input[type="password"], -textarea, -select { - height: 38px; - padding: 6px 10px; /* The 6px vertically centers text on FF, ignored by Webkit */ - background-color: #fff; - border: 1px solid #D1D1D1; - border-radius: 4px; - box-shadow: none; - box-sizing: border-box; } -/* Removes awkward default styles on some inputs for iOS */ -input[type="email"], -input[type="number"], -input[type="search"], -input[type="text"], -input[type="tel"], -input[type="url"], -input[type="password"], -textarea { - -webkit-appearance: none; - -moz-appearance: none; - appearance: none; } -textarea { - min-height: 65px; - padding-top: 6px; - padding-bottom: 6px; } -input[type="email"]:focus, -input[type="number"]:focus, -input[type="search"]:focus, -input[type="text"]:focus, -input[type="tel"]:focus, -input[type="url"]:focus, -input[type="password"]:focus, -textarea:focus, -select:focus { - border: 1px solid #33C3F0; - outline: 0; } -label, -legend { - display: block; - margin-bottom: .5rem; - font-weight: 600; } -fieldset { - padding: 0; - border-width: 0; } -input[type="checkbox"], -input[type="radio"] { - display: inline; } -label > .label-body { - display: inline-block; - margin-left: .5rem; - font-weight: normal; } - - -/* Lists -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -ul { - list-style: circle inside; } -ol { - list-style: decimal inside; } -ol, ul { - padding-left: 0; - margin-top: 0; } -ul ul, -ul ol, -ol ol, -ol ul { - margin: 1.5rem 0 1.5rem 3rem; - font-size: 90%; } -li { - margin-bottom: 1rem; } - - -/* Code -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -code { - padding: .2rem .5rem; - margin: 0 .2rem; - font-size: 90%; - white-space: nowrap; - background: #F1F1F1; - border: 1px solid #E1E1E1; - border-radius: 4px; } -pre > code { - display: block; - padding: 1rem 1.5rem; - white-space: pre; } - - -/* Tables -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -th, -td { - padding: 12px 15px; - text-align: left; - border-bottom: 1px solid #E1E1E1; } -th:first-child, -td:first-child { - padding-left: 0; } -th:last-child, -td:last-child { - padding-right: 0; } - - -/* Spacing -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -button, -.button { - margin-bottom: 1rem; } -input, -textarea, -select, -fieldset { - margin-bottom: 1.5rem; } -pre, -blockquote, -dl, -figure, -table, -p, -ul, -ol, -form { - margin-bottom: 2.5rem; } - - -/* Utilities -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -.u-full-width { - width: 100%; - box-sizing: border-box; } -.u-max-full-width { - max-width: 100%; - box-sizing: border-box; } -.u-pull-right { - float: right; } -.u-pull-left { - float: left; } - - -/* Misc -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -hr { - margin-top: 3rem; - margin-bottom: 3.5rem; - border-width: 0; - border-top: 1px solid #E1E1E1; } - - -/* Clearing -–––––––––––––––––––––––––––––––––––––––––––––––––– */ - -/* Self Clearing Goodness */ -.container:after, -.row:after, -.u-cf { - content: ""; - display: table; - clear: both; } - - -/* Media Queries -–––––––––––––––––––––––––––––––––––––––––––––––––– */ -/* -Note: The best way to structure the use of media queries is to create the queries -near the relevant code. For example, if you wanted to change the styles for buttons -on small devices, paste the mobile query code up in the buttons section and style it -there. -*/ - - -/* Larger than mobile */ -@media (min-width: 400px) {} - -/* Larger than phablet (also point when grid becomes active) */ -@media (min-width: 550px) {} - -/* Larger than tablet */ -@media (min-width: 750px) {} - -/* Larger than desktop */ -@media (min-width: 1000px) {} - -/* Larger than Desktop HD */ -@media (min-width: 1200px) {} diff --git a/frontend/images/favicon.png b/frontend/images/favicon.png deleted file mode 100644 index 7a3c81c1e32b4e4224452cf8261a585480caa0ea..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1156 zcmV-~1bh35P)Px(K1oDDR9FeUS6ygSR}lVo-6obMX;utd(pYw*xM;*axQ4d&FA%IGA~hPSg!&Re z%!{H3LD7)Nf>mf~DXa7+587b*Vq0rT+y^!IQ_&TXVq{}Xg2tsmWK$E{Rg$dV+}vF6 z#`_m=J8(F2&&-)`&YW}R%yq#z<@o*n3YW{ZhEo=^6_YQP>FIPj!A@E?`I7?!182!U zWwRxhod!YQaJ$|6s8`2UV5hIjAF*$nn3!mxGk;snv2q|c5D4ty$oVx(v2fUKIJzp%YyG-;+|bmTJITBB&Z-~d;>l)!%wq-3T*Hu{5vvj{FwB`QX)d;Q(oi9$K)StVkW z6c!eyhlhvdszTWU_0aWF=-{;b&=3w|^@mIFWhm}D9??d2iK8!I63Xsg){iGSF*2TdhFu$i_?LHwo`odIDct3 zl;>}naw>Tj*DjvJug8wyM9k^>l~=UK#Tzg}dsgRKg9|nMfVQ0#T)#Obt{lbsjm=KC zVN{<9&8@1ESY$JTRl9KNN*u|Qv3ha&CbWO;=u(M+wDT=6zzcm;gX)@ER92Rw`1u6^ zQrGcW*?Pnb=IDo*jCv#jQpq@?hQmh@t_x|pv91$n-nJ1Rl)Z;jcTGZ~X&W*LaiH5! zG<`7Cge@yqU_;B#h((X1slEn5pQ_|r0k7m_jb4F+oG#kkE+&IdSaNl0b4{3V^d>gw z648{}SSkh2Y<>K>1Mzm0RqdHlG41&@uX6K2kXK1+I7_;Js~2Mi8q>jn2l#QHJvdE0 z5^Q;n$C-@YV!zzLzBY8VvmM`_z722DTolcD9r>@y6QZXvB;s8-v}p~#%cyzuIvIRx zGMPN7yoNJ-j#VQ*A42oyVT4&EKYs-GVsWQ;U&{E*=U7ZKBepOj?#=KqOCNM#KPzP^ z^(PAw6-UbOb9CaRRKjMy6Z|s4Kc-wM)AgC~359DZkm@yCG^k=|{|I^qASDtNs)?Qr zC&XrzVCYw;976qo@am!bUw%xqs#xy?E7noApQL)_c!=j>`km9OoAQjN6bD~$&+BRL zA0tIW2UNvzDV^y=D; - - - - Stateline Dashboard - - - - - - - - - -
-
-

Stateline Dashboard

-
- -
- -
-
-

Worker Information

- - - - - - - - - - - - - -
AttributeValue
Number of workers connected1
-
-
-

Number of Samples

-
-
-
-
-
-

Energy

-
-
-
-

Min Energy

-
-
-
-
-
-

Sigma

-
-
-
-

Accept Rate

-
-
-
-
-
-

Beta

-
-
-
-

Swap Rate

-
-
-
-
- - - - - - - - diff --git a/frontend/js/chart.js b/frontend/js/chart.js deleted file mode 100644 index 77425f9..0000000 --- a/frontend/js/chart.js +++ /dev/null @@ -1,75 +0,0 @@ -var defaultOptions = { - 'resolution': 1, // 1 second - 'windowSize': 10 // last minute -}; - -var Chart = function(endpoint, elemId, callback, options) { - this.endpoint = endpoint; - this.columns = [['x']]; - this.callback = callback; - this.chart = c3.generate({ - bindto: elemId, - data: { - x: 'x', - columns: this.columns - }, - point: { - show: false - }, - transition: { - duration: 0 - }, - axis: { - y: { - tick: { - format: d3.format('.2f') - } - }, - }, - }); - - this.startTime = new Date().getTime() / 1000; - - this.options = defaultOptions; - if (options) { - for (var attr in options) { this.options[attr] = options[attr]; } - } -}; - -Chart.prototype.update = function(data, config) { - new_data = this.callback(data); - for (key in new_data) { - var idx = this.columns.map(function (col) { return col[0]; }).indexOf(key); - if (idx == -1) { - this.columns.push([key, new_data[key]]); - } else { - this.columns[idx].push(new_data[key]); - } - } - - this.columns[0].push(Math.floor(new Date().getTime() / 1000 - this.startTime)); - - // Since we're only looking at a window, delete old data if we've reached window size - if (this.columns[0].length - 1 > this.options['windowSize']) { - console.log(this.columns); - for (var i = 0; i < this.columns.length; i++) { - this.columns[i].splice(1, 1); - } - } - - var palette = ["#5DA5DA", "#FAA43A", "#60BD68", "#F17CB0", - "#B2912F", "#B276B2", "#DECF3F", "#F15854"]; - var colors = []; - for (var i = 0; i < config.stacks; i++) { - colors.push.apply(colors, new gradStop({ - stops: config.chainsPerStack + 1, - inColor: 'hex', - colorArray: [palette[i], '#FFFFFF'] - }).slice(0, -1)); - } - - this.chart.load({ - columns: this.columns, - colors: colors - }); -}; diff --git a/frontend/js/gradstop.min.js b/frontend/js/gradstop.min.js deleted file mode 100644 index e5ad51f..0000000 --- a/frontend/js/gradstop.min.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";function _classCallCheck(a,b){if(!(a instanceof b))throw new TypeError("Cannot call a class as a function")}var _createClass=function(){function a(a,b){for(var c=0;c Date: Fri, 29 Jul 2016 14:14:47 +1000 Subject: [PATCH 23/28] Fix tests --- src/comms/agent.cpp | 8 ++------ src/comms/delegator.cpp | 29 +++++++++++++++++++++++------ src/comms/endpoint.hpp | 24 +++++++++++++++++------- src/comms/heartbeat.cpp | 8 ++++---- src/test/agent.cpp | 7 ++++--- src/test/delegator.cpp | 9 ++++++--- src/test/main.cpp | 2 +- src/test/testsocket.hpp | 27 +++++++++++++++++++++++++++ 8 files changed, 84 insertions(+), 30 deletions(-) create mode 100644 src/test/testsocket.hpp diff --git a/src/comms/agent.cpp b/src/comms/agent.cpp index 2685252..a2d0639 100644 --- a/src/comms/agent.cpp +++ b/src/comms/agent.cpp @@ -79,7 +79,7 @@ struct Agent::NetworkEndpoint : Endpoint void onWelcome(const Message& m) { const auto welcome = protocol::unserialise(m.data); - agent.network.startHeartbeats("delegator", std::chrono::seconds{welcome.hbTimeoutSecs}); + agent.network.startHeartbeats(m.address, std::chrono::seconds{welcome.hbTimeoutSecs}); } void onJob(const Message& m) @@ -129,11 +129,7 @@ void Agent::start(bool& running) Router router{"agent", std::tie(worker, network)}; - const auto onIdle = [&network]() - { - // TODO: Ugly. - network.socket().heartbeats().idle(); - }; + const auto onIdle = [&network]() { network.idle(); }; do { diff --git a/src/comms/delegator.cpp b/src/comms/delegator.cpp index 4b5d6ef..1c9752a 100644 --- a/src/comms/delegator.cpp +++ b/src/comms/delegator.cpp @@ -179,6 +179,9 @@ struct Delegator::NetworkEndpoint : Endpoint // TODO: investigate lazy removal it = delegator.jobQueue.erase(it); } + + // Call base class idle + Endpoint::idle(); } void onResult(const Message& m) @@ -211,6 +214,25 @@ struct Delegator::NetworkEndpoint : Endpoint // Remove job from work in progress store worker.inProgress.erase(result.id); } + + void onBye(const Message& m) + { + socket().heartbeats().disconnect(m.address, DisconnectReason::USER_REQUESTED); + } + + void onHeartbeatDisconnect(const std::string& addr, DisconnectReason) + { + auto it = delegator.workers.find(addr); + if (it == delegator.workers.end()) + return; + + // Requeue the in progress jobs of this worker + SL_LOG(INFO) << "Re-queuing " << it->second.inProgress.size() << " jobs from " << addr; + for (const auto& kv : it->second.inProgress) + delegator.jobQueue.emplace_front(kv.second); + + delegator.workers.erase(it); + } }; Delegator::Delegator(zmq::context_t& ctx, const DelegatorSettings& settings) @@ -238,12 +260,7 @@ void Delegator::start(bool& running) Router router{"delegator", std::tie(requester, network)}; - const auto onIdle = [&network]() - { - network.idle(); - // TODO: Ugly. - network.socket().heartbeats().idle(); - }; + const auto onIdle = [&network]() { network.idle(); }; do { diff --git a/src/comms/endpoint.hpp b/src/comms/endpoint.hpp index 0bf2d7e..cde5cf6 100644 --- a/src/comms/endpoint.hpp +++ b/src/comms/endpoint.hpp @@ -26,6 +26,10 @@ class Endpoint explicit Endpoint(Socket& socket) : socket_{socket} { + socket.heartbeats().bindHeartbeat( + [this](const std::string& addr) { onHeartbeatSend(addr); }); + socket.heartbeats().bindDisconnect( + [this](const std::string& addr, DisconnectReason reason) { onHeartbeatDisconnect(addr, reason); }); } Socket& socket() { return socket_; } @@ -74,7 +78,9 @@ class Endpoint break; default: - // TODO: unrecognised subject + SL_LOG(WARNING) << "Received message with unknown subject " + << pprint("subject", m.subject); + self().onDefault(m); break; } @@ -90,8 +96,14 @@ class Endpoint void onBatchJob(const Message& m) { self().onDefault(m); } void onBatchResult(const Message& m) { self().onDefault(m); } - void onHeartbeatSend(const std::string& addr) { } - void onHeartbeatTimeout(const std::string& addr) { } + void onHeartbeatSend(const std::string& addr) + { + // Default behaviour is to send an empty heartbeat msg + SL_LOG(TRACE) << "Sending empty heartbeat " << pprint("addr", addr); + socket_.send({ addr, HEARTBEAT, "" }); + } + + void onHeartbeatDisconnect(const std::string&, DisconnectReason) { } void forwardMessage(Socket& s, const Message &m) { @@ -101,7 +113,7 @@ class Endpoint void idle() { - // handle heartbeats and disconnects + socket_.heartbeats().idle(); } private: @@ -110,6 +122,4 @@ class Endpoint Socket& socket_; }; -} // namespace stateline - -}// namespace comms +} } diff --git a/src/comms/heartbeat.cpp b/src/comms/heartbeat.cpp index 9577aaf..2cbf74d 100644 --- a/src/comms/heartbeat.cpp +++ b/src/comms/heartbeat.cpp @@ -22,7 +22,7 @@ Heartbeat::Heartbeat() void Heartbeat::connect(const std::string& addr, std::chrono::seconds timeout) { - SL_LOG(INFO) << addr << " connected " << pprint("timeout", timeout); + SL_LOG(INFO) << "New connection " << pprint("addr", addr, "timeout", timeout); // We send 2 heartbeats per timeout const auto interval = std::chrono::duration_cast(timeout) / 2; @@ -37,11 +37,11 @@ void Heartbeat::disconnect(const std::string& addr, DisconnectReason reason) switch (reason) { case DisconnectReason::USER_REQUESTED: - SL_LOG(INFO) << addr << " disconnected by request"; + SL_LOG(INFO) << "Connection closed by request " << pprint("addr", addr); break; case DisconnectReason::TIMEOUT: - SL_LOG(INFO) << addr << " disconnected by time out"; + SL_LOG(INFO) << "Connection closed by timeout " << pprint("addr", addr); break; } @@ -94,7 +94,7 @@ void Heartbeat::idle() // Disconnect if they missed 2 heartbeat intervals. if (it->second.lastRecvTime + it->second.interval * 2 < now) { - SL_LOG(INFO) << it->first << " disconnected by timeout " << pprint("timeout", it->second.interval * 2); + SL_LOG(INFO) << "Connection closed by timeout " << pprint("addr", it->first); disconnectCallback_(it->first, DisconnectReason::TIMEOUT); it = conns_.erase(it); } diff --git a/src/test/agent.cpp b/src/test/agent.cpp index 9502739..b887d9c 100644 --- a/src/test/agent.cpp +++ b/src/test/agent.cpp @@ -12,9 +12,12 @@ #include "comms/agent.hpp" #include "comms/protocol.hpp" +#include "testsocket.hpp" + #include using namespace stateline::comms; +using namespace stateline::test; using namespace std::chrono_literals; // Special HELLO sent from the worker @@ -38,7 +41,7 @@ TEST_CASE("agent can connect to network and worker", "[agent]") AgentSettings settings{"ipc://test_agent", "ipc://test_network"}; settings.heartbeatTimeout = 10s; - Socket network{ctx, zmq::socket_type::router, "network"}; + TestSocket network{ctx, zmq::socket_type::router, "network"}; network.bind(settings.networkAddress); Agent agent{ctx, settings}; @@ -77,8 +80,6 @@ TEST_CASE("agent can connect to network and worker", "[agent]") REQUIRE(network.send({ agentAddress, WELCOME, serialise(welcome) }) == true); agent.poll(); - // TODO: check heartbeats - SECTION("forwards JOB from network to worker") { { diff --git a/src/test/delegator.cpp b/src/test/delegator.cpp index 229c71e..ae0aad1 100644 --- a/src/test/delegator.cpp +++ b/src/test/delegator.cpp @@ -12,10 +12,13 @@ #include "comms/delegator.hpp" #include "comms/protocol.hpp" +#include "testsocket.hpp" + #include #include using namespace stateline::comms; +using namespace stateline::test; using namespace std::chrono_literals; TEST_CASE("delegator follows protocol", "[delegator]") @@ -26,7 +29,7 @@ TEST_CASE("delegator follows protocol", "[delegator]") settings.heartbeatTimeout = 10s; settings.numJobTypes = 3; - Socket network{ctx, zmq::socket_type::dealer, "network"}; + TestSocket network{ctx, zmq::socket_type::dealer, "network"}; network.connect(settings.networkAddress); Delegator delegator{ctx, settings}; @@ -130,10 +133,10 @@ TEST_CASE("delegator delegates jobs fairly", "[delegator]") settings.heartbeatTimeout = 10s; settings.numJobTypes = 2; - Socket network1{ctx, zmq::socket_type::dealer, "network"}; + TestSocket network1{ctx, zmq::socket_type::dealer, "network"}; network1.connect(settings.networkAddress); - Socket network2{ctx, zmq::socket_type::dealer, "network"}; + TestSocket network2{ctx, zmq::socket_type::dealer, "network"}; network2.connect(settings.networkAddress); Delegator delegator{ctx, settings}; diff --git a/src/test/main.cpp b/src/test/main.cpp index d8d8619..2397a7c 100644 --- a/src/test/main.cpp +++ b/src/test/main.cpp @@ -3,7 +3,7 @@ #include "app/logging.hpp" -const int logLevel = -3; +const std::string logLevel = "TEST"; const bool stdErr = false; const std::string filename = "test.log"; diff --git a/src/test/testsocket.hpp b/src/test/testsocket.hpp new file mode 100644 index 0000000..0258f9b --- /dev/null +++ b/src/test/testsocket.hpp @@ -0,0 +1,27 @@ +#pragma once + +#include "comms/socket.hpp" + +namespace stateline { namespace test { + +class TestSocket : public comms::Socket +{ +public: + TestSocket(zmq::context_t& ctx, zmq::socket_type type, const std::string& name) + : Socket{ctx, type, name} + { + } + + comms::Message recv() + { + // Ignore heartbeats + for (;;) + { + const auto msg = Socket::recv(); + if (msg.subject != comms::HEARTBEAT) + return msg; + } + } +}; + +} } From 74054cfd470d32bca0f23608f6ba82f5811b155a Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Fri, 29 Jul 2016 14:19:10 +1000 Subject: [PATCH 24/28] Remove frontend in CMake --- CMakeLists.txt | 5 ----- 1 file changed, 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index e18f7b3..94d6364 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -143,11 +143,6 @@ ADD_LIBRARY(stateline-client STATIC TARGET_LINK_LIBRARIES(stateline-client ${ZMQ_LIBRARY}) SET_TARGET_PROPERTIES(stateline-client PROPERTIES LINKER_LANGUAGE CXX) -############################################################################## -# Move the frontend code to the build folder -############################################################################## -FILE(COPY frontend DESTINATION ${STATELINE_BINARY_DIR}) - ############################################################################## # Install binaries ############################################################################## From 22575e57d8936391522b83abee0e84ef5dc7fd54 Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Fri, 12 Aug 2016 13:17:48 +1000 Subject: [PATCH 25/28] Deprecate signals --- CMakeLists.txt | 2 +- src/app/signal.cpp | 31 +++++++++++++++++-------------- src/app/signal.hpp | 25 ++++++++++++------------- src/common/logging.hpp | 4 ++++ 4 files changed, 34 insertions(+), 28 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 94d6364..35d2bf8 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -45,7 +45,7 @@ ENDIF(LOCAL_INSTALL) SET(CMAKE_CXX_STANDARD_REQUIRED ON) SET(CMAKE_CXX_STANDARD 14) -SET(sl_flags "-D_GLIBCXX_USE_NANOSLEEP -std=c++11 -fPIC") +SET(sl_flags "-D_GLIBCXX_USE_NANOSLEEP") SET(sl_warnings "-Wall -Wno-unused-local-typedefs -Wextra -pedantic") SET(sl_debug "-ggdb -g") SET(sl_release "-DNDEBUG -O2") diff --git a/src/app/signal.cpp b/src/app/signal.cpp index 8322193..0a0eb41 100644 --- a/src/app/signal.cpp +++ b/src/app/signal.cpp @@ -8,6 +8,11 @@ //! \copyright (c) 2014, NICTA //! +// DO NOT USE +// C++ std::signal causes undefined behaviour in multithreaded programs +// http://en.cppreference.com/w/cpp/utility/program/signal + +/* #include #include #include @@ -18,28 +23,26 @@ std::atomic_bool stateline::global::interruptedBySignal = ATOMIC_VAR_INIT(false); -void stateline::init::handleSignal(int sig) +void handleSignal(int sig) { - VLOG(1) << "Caught Signal of type " << sig; + SL_LOG(INFO) << "Caught Signal of type " << sig; stateline::global::interruptedBySignal = true; } -void stateline::init::threadHandle() +void initialiseSignalHandler() { + // Install a signal handler std::signal(SIGINT, handleSignal); std::signal(SIGTERM, handleSignal); - while(!global::interruptedBySignal) - { - std::this_thread::sleep_for(std::chrono::seconds(60)); - } + std::signal(SIGPROF, handleSignal); + //std::signal(SIGINT, SIG_IGN); + //std::signal(SIGTERM, SIG_IGN); + //std::thread(threadHandle).detach(); } -void stateline::init::initialiseSignalHandler() +bool isRunning() { - // Install a signal handler - // std::signal(SIGINT, handleSignal); - // std::signal(SIGTERM, handleSignal); - std::signal(SIGINT, SIG_IGN); - std::signal(SIGTERM, SIG_IGN); - std::thread(threadHandle).detach(); + return !interruptedBySignal.get(); } + +}*/ diff --git a/src/app/signal.hpp b/src/app/signal.hpp index d9fb46a..67d53d1 100644 --- a/src/app/signal.hpp +++ b/src/app/signal.hpp @@ -10,19 +10,18 @@ #pragma once +// DO NOT USE +// C++ std::signal causes undefined behaviour in multithreaded programs +// http://en.cppreference.com/w/cpp/utility/program/signal + +/* #include -namespace stateline -{ - namespace global - { - extern std::atomic_bool interruptedBySignal; - } +namespace stateline { + +// TODO use atomic +void initialiseSignalHandler(); + +bool isRunning(); - namespace init - { - void handleSignal(int sig); - void threadHandle(); - void initialiseSignalHandler(); - } -} +}*/ diff --git a/src/common/logging.hpp b/src/common/logging.hpp index bc9eb73..5edb5d1 100644 --- a/src/common/logging.hpp +++ b/src/common/logging.hpp @@ -75,11 +75,15 @@ void pprintImpl(std::ostringstream& s, const std::string& key, const T& val, Arg template std::string pprint(Args&&... args) { +#ifdef NDEBUG + return ""; +#else std::ostringstream ss; ss << "["; detail::pprintImpl(ss, std::forward(args)...); ss << "]"; return ss.str(); +#endif } } From b8348a6d2e084d645f24c73de3b6ba69ae1b18ef Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Fri, 12 Aug 2016 13:18:05 +1000 Subject: [PATCH 26/28] Fix return by value in lastState --- src/infer/chainarray.cpp | 2 +- src/infer/chainarray.hpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/infer/chainarray.cpp b/src/infer/chainarray.cpp index d682b6e..cb2d51a 100644 --- a/src/infer/chainarray.cpp +++ b/src/infer/chainarray.cpp @@ -154,7 +154,7 @@ namespace stateline cache_[id].push_back(recent); } - State ChainArray::lastState(uint id) const + const State& ChainArray::lastState(uint id) const { return cache_[id].back(); } diff --git a/src/infer/chainarray.hpp b/src/infer/chainarray.hpp index 65efe6d..df04ce1 100644 --- a/src/infer/chainarray.hpp +++ b/src/infer/chainarray.hpp @@ -88,7 +88,7 @@ namespace stateline //! \param id The id of the chain (see \ref id). //! \return The most recent state in the chain. //! - State lastState(uint id) const; + const State& lastState(uint id) const; //! Attempt to swap the states in two different chains. //! From eb97544707eefcdc35d3e9310aa836d3864d3315 Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Fri, 12 Aug 2016 17:11:02 +1000 Subject: [PATCH 27/28] Use HDF5 --- CMakeLists.txt | 11 +- README.md | 2 - external/simple-web-server/server_http.hpp | 375 --------------------- src/app/serverwrapper.cpp | 2 +- src/app/serverwrapper.hpp | 10 +- src/bin/CMakeLists.txt | 8 +- src/db/db.cpp | 109 ++++-- src/db/db.hpp | 52 +-- src/infer/chainarray.cpp | 6 +- src/infer/chainarray.hpp | 5 +- 10 files changed, 125 insertions(+), 455 deletions(-) delete mode 100755 external/simple-web-server/server_http.hpp diff --git a/CMakeLists.txt b/CMakeLists.txt index 35d2bf8..2765c70 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -78,6 +78,9 @@ FIND_PACKAGE(ZMQ REQUIRED) # Eigen FIND_PACKAGE(Eigen3 3.2.0 REQUIRED) +# HDF5 +FIND_PACKAGE(HDF5 REQUIRED COMPONENTS CXX) + ############################################################################## # INCLUDE DIRECTORIES ############################################################################## @@ -87,9 +90,9 @@ INCLUDE_DIRECTORIES("${STATELINE_SOURCE_DIR}/src" SYSTEM "${STATELINE_SOURCE_DIR}/external" SYSTEM "${STATELINE_SOURCE_DIR}/external/cppzmq" SYSTEM "${STATELINE_SOURCE_DIR}/external/json" - SYSTEM "${STATELINE_SOURCE_DIR}/external/simple-web-server" SYSTEM "${ZMQ_INCLUDE_DIR}" - SYSTEM "${EIGEN3_INCLUDE_DIR}") + SYSTEM "${EIGEN3_INCLUDE_DIR}" + SYSTEM "${HDF5_INCLUDE_DIRS}") ADD_SUBDIRECTORY(src/test) @@ -134,13 +137,13 @@ ADD_LIBRARY(stateline-server STATIC $ $ $ $ $ $) -TARGET_LINK_LIBRARIES(stateline-server ${ZMQ_LIBRARY}) +TARGET_LINK_LIBRARIES(stateline-server) SET_TARGET_PROPERTIES(stateline-server PROPERTIES LINKER_LANGUAGE CXX) ADD_LIBRARY(stateline-client STATIC $ $ $) -TARGET_LINK_LIBRARIES(stateline-client ${ZMQ_LIBRARY}) +TARGET_LINK_LIBRARIES(stateline-client) SET_TARGET_PROPERTIES(stateline-client PROPERTIES LINKER_LANGUAGE CXX) ############################################################################## diff --git a/README.md b/README.md index f48645e..7f9db86 100644 --- a/README.md +++ b/README.md @@ -151,9 +151,7 @@ To build stateline, you will need the following: You will need install the following libraries through your operating system's package manager: -* Boost 1.58+ * Eigen 3.2.0+ -* google-test 1.7.0+ * zeromq 4.0+ To run the python demos, you will also need: diff --git a/external/simple-web-server/server_http.hpp b/external/simple-web-server/server_http.hpp deleted file mode 100755 index afb36c0..0000000 --- a/external/simple-web-server/server_http.hpp +++ /dev/null @@ -1,375 +0,0 @@ -#ifndef SERVER_HTTP_HPP -#define SERVER_HTTP_HPP - -#include -#include -#include - -#include -#include -#include -#include -#include - -namespace SimpleWeb { - template - class ServerBase { - public: - class Response : public std::ostream { - friend class ServerBase; - private: - boost::asio::yield_context& yield; - - boost::asio::streambuf streambuf; - - socket_type &socket; - - Response(socket_type &socket, boost::asio::yield_context& yield): - std::ostream(&streambuf), yield(yield), socket(socket) {} - - public: - size_t size() { - return streambuf.size(); - } - void flush() { - boost::system::error_code ec; - boost::asio::async_write(socket, streambuf, yield[ec]); - - if(ec) - throw std::runtime_error(ec.message()); - } - }; - - class Content : public std::istream { - friend class ServerBase; - public: - size_t size() { - return streambuf.size(); - } - std::string string() { - std::stringstream ss; - ss << rdbuf(); - return ss.str(); - } - private: - boost::asio::streambuf &streambuf; - Content(boost::asio::streambuf &streambuf): std::istream(&streambuf), streambuf(streambuf) {} - }; - - class Request { - friend class ServerBase; - public: - std::string method, path, http_version; - - Content content; - - std::unordered_multimap header; - - boost::smatch path_match; - - std::string remote_endpoint_address; - unsigned short remote_endpoint_port; - - private: - Request(boost::asio::io_service &io_service): content(streambuf), strand(io_service) {} - - boost::asio::streambuf streambuf; - - boost::asio::strand strand; - - void read_remote_endpoint_data(socket_type& socket) { - try { - remote_endpoint_address=socket.lowest_layer().remote_endpoint().address().to_string(); - remote_endpoint_port=socket.lowest_layer().remote_endpoint().port(); - } - catch(const std::exception& e) {} - } - }; - - class Config { - friend class ServerBase; - private: - Config(unsigned short port, size_t num_threads): port(port), num_threads(num_threads) {} - unsigned short port; - size_t num_threads; - public: - ///IPv4 address in dotted decimal form or IPv6 address in hexadecimal notation. - ///If empty, the address will be any address. - std::string address; - ///Set to false to avoid binding the socket to an address that is already in use. - bool reuse_address=true; - }; - ///Set before calling start(). - Config config; - - std::unordered_map::Response&, std::shared_ptr::Request>)> > > resource; - - std::unordered_map::Response&, std::shared_ptr::Request>)> > default_resource; - - private: - std::vector::Response&, std::shared_ptr::Request>)> > > > > opt_resource; - - public: - void start() { - //Copy the resources to opt_resource for more efficient request processing - opt_resource.clear(); - for(auto& res: resource) { - for(auto& res_method: res.second) { - auto it=opt_resource.end(); - for(auto opt_it=opt_resource.begin();opt_it!=opt_resource.end();opt_it++) { - if(res_method.first==opt_it->first) { - it=opt_it; - break; - } - } - if(it==opt_resource.end()) { - opt_resource.emplace_back(); - it=opt_resource.begin()+(opt_resource.size()-1); - it->first=res_method.first; - } - it->second.emplace_back(boost::regex(res.first), res_method.second); - } - } - - std::unique_ptr endpoint; - if(config.address.size()>0) - endpoint=std::unique_ptr(new boost::asio::ip::tcp::endpoint(boost::asio::ip::address::from_string(config.address), config.port)); - else - endpoint=std::unique_ptr(new boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), config.port)); - acceptor.open(endpoint->protocol()); - acceptor.set_option(boost::asio::socket_base::reuse_address(config.reuse_address)); - acceptor.bind(*endpoint); - acceptor.listen(); - - accept(); - - //If num_threads>1, start m_io_service.run() in (num_threads-1) threads for thread-pooling - threads.clear(); - for(size_t c=1;c threads; - - size_t timeout_request; - size_t timeout_content; - - ServerBase(unsigned short port, size_t num_threads, size_t timeout_request, size_t timeout_send_or_receive) : - config(port, num_threads), acceptor(io_service), - timeout_request(timeout_request), timeout_content(timeout_send_or_receive) {} - - virtual void accept()=0; - - std::shared_ptr set_timeout_on_socket(std::shared_ptr socket, size_t seconds) { - std::shared_ptr timer(new boost::asio::deadline_timer(io_service)); - timer->expires_from_now(boost::posix_time::seconds(seconds)); - timer->async_wait([socket](const boost::system::error_code& ec){ - if(!ec) { - boost::system::error_code ec; - socket->lowest_layer().shutdown(boost::asio::ip::tcp::socket::shutdown_both, ec); - socket->lowest_layer().close(); - } - }); - return timer; - } - - std::shared_ptr set_timeout_on_socket(std::shared_ptr socket, std::shared_ptr request, size_t seconds) { - std::shared_ptr timer(new boost::asio::deadline_timer(io_service)); - timer->expires_from_now(boost::posix_time::seconds(seconds)); - timer->async_wait(request->strand.wrap([socket](const boost::system::error_code& ec){ - if(!ec) { - boost::system::error_code ec; - socket->lowest_layer().shutdown(boost::asio::ip::tcp::socket::shutdown_both, ec); - socket->lowest_layer().close(); - } - })); - return timer; - } - - void read_request_and_content(std::shared_ptr socket) { - //Create new streambuf (Request::streambuf) for async_read_until() - //shared_ptr is used to pass temporary objects to the asynchronous functions - std::shared_ptr request(new Request(io_service)); - request->read_remote_endpoint_data(*socket); - - //Set timeout on the following boost::asio::async-read or write function - std::shared_ptr timer; - if(timeout_request>0) - timer=set_timeout_on_socket(socket, timeout_request); - - boost::asio::async_read_until(*socket, request->streambuf, "\r\n\r\n", - [this, socket, request, timer](const boost::system::error_code& ec, size_t bytes_transferred) { - if(timeout_request>0) - timer->cancel(); - if(!ec) { - //request->streambuf.size() is not necessarily the same as bytes_transferred, from Boost-docs: - //"After a successful async_read_until operation, the streambuf may contain additional data beyond the delimiter" - //The chosen solution is to extract lines from the stream directly when parsing the header. What is left of the - //streambuf (maybe some bytes of the content) is appended to in the async_read-function below (for retrieving content). - size_t num_additional_bytes=request->streambuf.size()-bytes_transferred; - - parse_request(request, request->content); - - //If content, read that as well - const auto it=request->header.find("Content-Length"); - if(it!=request->header.end()) { - //Set timeout on the following boost::asio::async-read or write function - std::shared_ptr timer; - if(timeout_content>0) - timer=set_timeout_on_socket(socket, timeout_content); - unsigned long long content_length; - try { - content_length=stoull(it->second); - } - catch(const std::exception &e) { - return; - } - boost::asio::async_read(*socket, request->streambuf, - boost::asio::transfer_exactly(content_length-num_additional_bytes), - [this, socket, request, timer] - (const boost::system::error_code& ec, size_t /*bytes_transferred*/) { - if(timeout_content>0) - timer->cancel(); - if(!ec) - find_resource(socket, request); - }); - } - else { - find_resource(socket, request); - } - } - }); - } - - void parse_request(std::shared_ptr request, std::istream& stream) const { - std::string line; - getline(stream, line); - size_t method_end=line.find(' '); - size_t path_end=line.find(' ', method_end+1); - if(method_end!=std::string::npos && path_end!=std::string::npos) { - request->method=line.substr(0, method_end); - request->path=line.substr(method_end+1, path_end-method_end-1); - request->http_version=line.substr(path_end+6, line.size()-path_end-7); - - getline(stream, line); - size_t param_end=line.find(':'); - while(param_end!=std::string::npos) { - size_t value_start=param_end+1; - if(line[value_start]==' ') - value_start++; - - std::string key=line.substr(0, param_end); - request->header.insert(std::make_pair(key, line.substr(value_start, line.size()-value_start-1))); - - getline(stream, line); - param_end=line.find(':'); - } - } - } - - void find_resource(std::shared_ptr socket, std::shared_ptr request) { - //Find path- and method-match, and call write_response - for(auto& res: opt_resource) { - if(request->method==res.first) { - for(auto& res_path: res.second) { - boost::smatch sm_res; - if(boost::regex_match(request->path, sm_res, res_path.first)) { - request->path_match=std::move(sm_res); - write_response(socket, request, res_path.second); - return; - } - } - } - } - auto it_method=default_resource.find(request->method); - if(it_method!=default_resource.end()) { - write_response(socket, request, it_method->second); - } - } - - void write_response(std::shared_ptr socket, std::shared_ptr request, - std::function::Response&, std::shared_ptr::Request>)>& resource_function) { - //Set timeout on the following boost::asio::async-read or write function - std::shared_ptr timer; - if(timeout_content>0) - timer=set_timeout_on_socket(socket, request, timeout_content); - - boost::asio::spawn(request->strand, [this, &resource_function, socket, request, timer](boost::asio::yield_context yield) { - Response response(*socket, yield); - - try { - resource_function(response, request); - } - catch(const std::exception& e) { - return; - } - - if(response.size()>0) { - try { - response.flush(); - } - catch(const std::exception &e) { - return; - } - } - if(timeout_content>0) - timer->cancel(); - if(stof(request->http_version)>1.05) - read_request_and_content(socket); - }); - } - }; - - template - class Server : public ServerBase {}; - - typedef boost::asio::ip::tcp::socket HTTP; - - template<> - class Server : public ServerBase { - public: - Server(unsigned short port, size_t num_threads=1, size_t timeout_request=5, size_t timeout_content=300) : - ServerBase::ServerBase(port, num_threads, timeout_request, timeout_content) {} - - private: - void accept() { - //Create new socket for this connection - //Shared_ptr is used to pass temporary objects to the asynchronous functions - std::shared_ptr socket(new HTTP(io_service)); - - acceptor.async_accept(*socket, [this, socket](const boost::system::error_code& ec){ - //Immediately start accepting a new connection - accept(); - - if(!ec) { - boost::asio::ip::tcp::no_delay option(true); - socket->set_option(option); - - read_request_and_content(socket); - } - }); - } - }; -} -#endif /* SERVER_HTTP_HPP */ diff --git a/src/app/serverwrapper.cpp b/src/app/serverwrapper.cpp index e600bce..b883562 100644 --- a/src/app/serverwrapper.cpp +++ b/src/app/serverwrapper.cpp @@ -56,7 +56,7 @@ void runSampler(const StatelineSettings& s, zmq::context_t& ctx, comms::Delegato mcmc::RegressionAdapter sigmaAdapter(s.nstacks, s.ntemps, s.optimalAcceptRate, min_log_ratio, max_log_ratio); mcmc::RegressionAdapter betaAdapter(s.nstacks, s.ntemps, s.optimalSwapRate, 0., max_log_ratio); mcmc::GaussianProposal proposal(s.nstacks, s.ntemps, s.ndims, s.proposalBounds, initial_count); - mcmc::ChainArray chains(s.nstacks, s.ntemps, s.outputPath); + mcmc::ChainArray chains(s.nstacks, s.ntemps, s.db); comms::Requester requester{ctx, delegator.settings().requesterAddress}; // Initialise chains to valid states diff --git a/src/app/serverwrapper.hpp b/src/app/serverwrapper.hpp index d705681..1cf8646 100644 --- a/src/app/serverwrapper.hpp +++ b/src/app/serverwrapper.hpp @@ -56,7 +56,7 @@ struct StatelineSettings std::size_t heartbeatTimeoutSec; - std::string outputPath; + db::DBSettings db; static StatelineSettings fromJSON(const nlohmann::json& j) { @@ -67,7 +67,6 @@ struct StatelineSettings readFields(j, "swapInterval", s.swapInterval); readFields(j, "loggingRateSec", s.loggingRateSec); readFields(j, "nJobTypes", s.nJobTypes); - readFields(j, "outputPath", s.outputPath); readFields(j, "optimalAcceptRate", s.optimalAcceptRate); readFields(j, "optimalSwapRate", s.optimalSwapRate); readFieldsWithDefault(j, "useInitial", s.useInitial, false); @@ -86,6 +85,13 @@ struct StatelineSettings s.proposalBounds = mcmc::ProposalBoundsFromJSON(j); s.ndims = s.proposalBounds.min.size(); //ProposalBounds checks they're the same + + // DB settings + readFields(j, "outputPath", s.db.filename); + s.db.numChains = s.nstacks / s.ntemps; + s.db.numDims = s.ndims; + s.db.chunkSize = 100; // TODO make this a setting + return s; } }; diff --git a/src/bin/CMakeLists.txt b/src/bin/CMakeLists.txt index 7203d2d..9666181 100644 --- a/src/bin/CMakeLists.txt +++ b/src/bin/CMakeLists.txt @@ -12,15 +12,9 @@ FUNCTION(ADD_BINARY fname name library) SET_TARGET_PROPERTIES(${name} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${STATELINE_BINARY_DIR}) - TARGET_LINK_LIBRARIES(${name} ${library}) + TARGET_LINK_LIBRARIES(${name} ${library} ${ZMQ_LIBRARY} ${HDF5_CXX_LIBRARIES}) INSTALL (TARGETS ${name} RUNTIME DESTINATION bin) ENDFUNCTION() -FUNCTION(COPY_FILE name) - IF (NOT EXISTS "${STATELINE_BINARY_DIR}/${name}") - CONFIGURE_FILE(${name} "${STATELINE_BINARY_DIR}/${name}" COPYONLY) - ENDIF() -ENDFUNCTION() - ADD_BINARY(server.cpp sl-server stateline-server) ADD_BINARY(agent.cpp sl-agent stateline-client) diff --git a/src/db/db.cpp b/src/db/db.cpp index ecaa055..69c6ce0 100644 --- a/src/db/db.cpp +++ b/src/db/db.cpp @@ -11,40 +11,81 @@ #include "db/db.hpp" -namespace stateline +#include + +namespace stateline { namespace db { + +DBWriter::DBWriter(const DBSettings& settings) + : settings_{settings} + , file_{settings.filename.c_str(), H5F_ACC_EXCL} { - namespace db + for (std::size_t i = 0; i < settings.numChains; i++) { - std::ostream& operator<<(std::ostream& os, const mcmc::State& s) - { - for (uint i = 0; i < s.sample.size(); i++) { - os << s.sample(i) << ","; - } - os << s.energy << "," << s.sigma << "," << s.beta << "," << s.accepted << "," << (int)s.swapType; - return os; - } - - CSVChainArrayWriter::CSVChainArrayWriter(const std::string& directory, uint numChains) - : chainFiles_(numChains) - { - for (uint i = 0; i < numChains; i++) { - chainFiles_[i].open(directory + "/" + std::to_string(i) + ".csv", - std::fstream::in | std::fstream::out | std::fstream::trunc); - assert(chainFiles_[i].good()); - } - } - - void CSVChainArrayWriter::append(int id, std::vector::iterator start, - std::vector::iterator end) - { - // TODO: needs to be transactional - assert(id >= 0 && id < chainFiles_.size()); - - std::for_each(start, end, [&](const mcmc::State &s){ - chainFiles_[id] << s << "\n";}); - - chainFiles_[id] << std::flush; - } - } // namespace db -} // namespace stateline + const std::string groupName = "/chain" + std::to_string(i); + + // Create a group for each chain + groups_.push_back(file_.createGroup(groupName.c_str())); + + // Create the dataspace for the samples + const hsize_t dims[] = { 0, settings.numDims }; + const hsize_t maxdims[] = { H5S_UNLIMITED, settings.numDims }; + H5::DataSpace dataspace{2, dims, maxdims}; + + // Enable chunking + H5::DSetCreatPropList prop; + const hsize_t chunk_dims[] = { settings.chunkSize, settings.numDims }; + prop.setChunk(2, chunk_dims); + + // Create a dataset to hold its samples + datasets_.push_back(file_.createDataSet( + (groupName + "/samples").c_str(), + H5::PredType::NATIVE_DOUBLE, + dataspace, + prop + )); + } + + // Reserve the samples buffer + sbuffer_.reserve(settings.chunkSize * settings.numDims); +} + +void DBWriter::appendStates(std::size_t id, std::vector::iterator start, + std::vector::iterator end) +{ + // TODO: needs to be transactional + assert(id >= 0 && id < datasets_.size()); + + // Copy in the samples + sbuffer_.clear(); + for (auto it = start; it != end; ++it) + { + for (std::size_t i = 0; i < it->sample.size(); i++) + sbuffer_.push_back(it->sample(i)); + } + + // Define a memory dataspace to copy all the data to the file dataspace + const hsize_t dims[] = { sbuffer_.size() }; + H5::DataSpace memspace(1, dims); + + + // Extend the dataspace + H5::DataSpace dataspace = datasets_[id].getSpace(); + + const hsize_t oldLength = dataspace.getSimpleExtentNpoints() / settings_.numDims; + const hsize_t offset[] = { oldLength, 0 }; + const hsize_t stride[] = { 1, 1 }; + const hsize_t count[] = { sbuffer_.size() / settings_.numDims, settings_.numDims }; + const hsize_t block[] = { 1, 1 }; + const hsize_t newSize[] = { offset[0] + count[0], settings_.numDims }; + + datasets_[id].extend(newSize); + + // Select the new (extended) hyperslab + H5::DataSpace filespace = datasets_[id].getSpace(); + + filespace.selectHyperslab(H5S_SELECT_SET, count, offset, stride, block); + + datasets_[id].write(sbuffer_.data(), H5::PredType::NATIVE_DOUBLE, memspace, filespace); +} +} } diff --git a/src/db/db.hpp b/src/db/db.hpp index 98936bc..76e71ea 100644 --- a/src/db/db.hpp +++ b/src/db/db.hpp @@ -10,33 +10,37 @@ #pragma once +#include "infer/datatypes.hpp" + #include #include -#include -#include -#include "settings.hpp" -#include "../infer/datatypes.hpp" +#include "H5Cpp.h" -#include +namespace stateline { namespace db { -namespace stateline +struct DBSettings +{ + std::string filename; + std::size_t numChains; + std::size_t numDims; + std::size_t chunkSize; +}; + +// Database writer interface +class DBWriter { - namespace db - { - std::ostream& operator<<(std::ostream& os, const mcmc::State& s); - - // Database writer interface - class CSVChainArrayWriter - { - public: - CSVChainArrayWriter(const std::string& directory, uint numChains); - void append(int id, std::vector::iterator start, - std::vector::iterator end); - - private: - std::vector chainFiles_; - }; - - } // namespace db -} // namespace stateline +public: + DBWriter(const DBSettings& settings); + void appendStates(std::size_t id, std::vector::iterator start, + std::vector::iterator end); + +private: + DBSettings settings_; + H5::H5File file_; + std::vector groups_; + std::vector datasets_; + std::vector sbuffer_; +}; + +} } diff --git a/src/infer/chainarray.cpp b/src/infer/chainarray.cpp index cb2d51a..ebfffa6 100644 --- a/src/infer/chainarray.cpp +++ b/src/infer/chainarray.cpp @@ -67,8 +67,8 @@ namespace stateline } - ChainArray::ChainArray(uint nStacks, uint nTemps, const std::string& outputPath) - : writer_(outputPath, nStacks), + ChainArray::ChainArray(uint nStacks, uint nTemps, const db::DBSettings& settings) + : writer_(settings), nstacks_(nStacks), ntemps_(nTemps), lengthOnDisk_(nStacks * nTemps, 0), @@ -141,7 +141,7 @@ namespace stateline if (chainIndex(id) == 0) { VLOG(3) << "Flushing cache of chain " << id << ". new length on disk: " << newLength; - writer_.append(id / numTemps(), std::begin(cache_[id]), + writer_.appendStates(id / numTemps(), std::begin(cache_[id]), std::end(cache_[id])-1); } diff --git a/src/infer/chainarray.hpp b/src/infer/chainarray.hpp index df04ce1..2198882 100644 --- a/src/infer/chainarray.hpp +++ b/src/infer/chainarray.hpp @@ -46,7 +46,7 @@ namespace stateline //! \param nTemps The number of chains in each stack. //! \param settings The Chain array settings object // - ChainArray(uint nStacks, uint nTemps, const std::string& outputPath); + ChainArray(uint nStacks, uint nTemps, const db::DBSettings& settings); // Move constructor only ChainArray(ChainArray&& other); @@ -161,8 +161,7 @@ namespace stateline //! void recoverFromDisk(uint id); - //mutable db::Database db_; // Mutable so that chain queries can be const - db::CSVChainArrayWriter writer_; + db::DBWriter writer_; uint nstacks_; uint ntemps_; std::vector lengthOnDisk_; From 859df61be54ea611048b5a9be7873301fd25693f Mon Sep 17 00:00:00 2001 From: Darren Shen Date: Thu, 18 Aug 2016 09:18:44 +1000 Subject: [PATCH 28/28] Add HDF5 to Dockerfile --- Dockerfile | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/Dockerfile b/Dockerfile index a7a33c3..f2b0c13 100644 --- a/Dockerfile +++ b/Dockerfile @@ -6,15 +6,7 @@ RUN apt-get update && apt-get install -y \ cmake \ libeigen3-dev \ libzmq3-dev \ - libboost-program-options-dev \ - libboost-system-dev \ - libboost-filesystem-dev \ - libboost-regex-dev \ - libboost-coroutine-dev \ - libboost-thread-dev \ - libboost-date-time-dev \ - libboost-context-dev \ - libgtest-dev + libhdf5-dev ENV BUILD_DIR=/tmp/stateline LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib