/*! \file polymorphic_impl.hpp \brief Internal polymorphism support \ingroup Internal */ /* Copyright (c) 2014, Randolph Voorhies, Shane Grant All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of cereal nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RANDOLPH VOORHIES OR SHANE GRANT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /* This code is heavily inspired by the boost serialization implementation by the following authors (C) Copyright 2002 Robert Ramey - http://www.rrsd.com . Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See http://www.boost.org/LICENSE_1_0.txt) See http://www.boost.org for updates, documentation, and revision history. (C) Copyright 2006 David Abrahams - http://www.boost.org. See /boost/serialization/export.hpp, /boost/archive/detail/register_archive.hpp, and /boost/serialization/void_cast.hpp for their implementation. Additional details found in other files split across serialization and archive. */ #ifndef CEREAL_DETAILS_POLYMORPHIC_IMPL_HPP_ #define CEREAL_DETAILS_POLYMORPHIC_IMPL_HPP_ #include #include #include #include #include #include #include //! Binds a polymorhic type to all registered archives /*! This binds a polymorphic type to all compatible registered archives that have been registered with CEREAL_REGISTER_ARCHIVE. This must be called after all archives are registered (usually after the archives themselves have been included). */ #define CEREAL_BIND_TO_ARCHIVES(...) \ namespace cereal { \ namespace detail { \ template<> \ struct init_binding<__VA_ARGS__> { \ static bind_to_archives<__VA_ARGS__> const & b; \ static void unused() { (void)b; } \ }; \ bind_to_archives<__VA_ARGS__> const & init_binding<__VA_ARGS__>::b = \ ::cereal::detail::StaticObject< \ bind_to_archives<__VA_ARGS__> \ >::getInstance().bind(); \ }} /* end namespaces */ namespace cereal { /* Polymorphic casting support */ namespace detail { //! Base type for polymorphic void casting /*! Contains functions for casting between registered base and derived types. This is necessary so that cereal can properly cast between polymorphic types even though void pointers are used, which normally have no type information. Runtime type information is used instead to index a compile-time made mapping that can perform the proper cast. In the case of multiple levels of inheritance, cereal will attempt to find the shortest path by using registered relationships to perform the cast. This class will be allocated as a StaticObject and only referenced by pointer, allowing a templated derived version of it to define strongly typed functions that cast between registered base and derived types. */ struct PolymorphicCaster { PolymorphicCaster() = default; PolymorphicCaster( const PolymorphicCaster & ) = default; PolymorphicCaster & operator=( const PolymorphicCaster & ) = default; PolymorphicCaster( PolymorphicCaster && ) CEREAL_NOEXCEPT {} PolymorphicCaster & operator=( PolymorphicCaster && ) CEREAL_NOEXCEPT { return *this; } virtual ~PolymorphicCaster() CEREAL_NOEXCEPT = default; //! Downcasts to the proper derived type virtual void const * downcast( void const * const ptr ) const = 0; //! Upcast to proper base type virtual void * upcast( void * const ptr ) const = 0; //! Upcast to proper base type, shared_ptr version virtual std::shared_ptr upcast( std::shared_ptr const & ptr ) const = 0; }; //! Holds registered mappings between base and derived types for casting /*! This will be allocated as a StaticObject and holds a map containing all registered mappings between base and derived types. */ struct PolymorphicCasters { //! Maps from base type index to a map from derived type index to caster std::map>> map; //! Error message used for unregistered polymorphic casts #define UNREGISTERED_POLYMORPHIC_CAST_EXCEPTION(LoadSave) \ throw cereal::Exception("Trying to " #LoadSave " a registered polymorphic type with an unregistered polymorphic cast.\n" \ "Could not find a path to a base class (" + util::demangle(baseInfo.name()) + ") for type: " + ::cereal::util::demangledName() + "\n" \ "Make sure you either serialize the base class at some point via cereal::base_class or cereal::virtual_base_class.\n" \ "Alternatively, manually register the association with CEREAL_REGISTER_POLYMORPHIC_RELATION."); //! Checks if the mapping object that can perform the upcast or downcast /*! Uses the type index from the base and derived class to find the matching registered caster. If no matching caster exists, returns false. */ static bool exists( std::type_index const & baseIndex, std::type_index const & derivedIndex ) { // First phase of lookup - match base type index auto const & baseMap = StaticObject::getInstance().map; auto baseIter = baseMap.find( baseIndex ); if (baseIter == baseMap.end()) return false; // Second phase - find a match from base to derived auto & derivedMap = baseIter->second; auto derivedIter = derivedMap.find( derivedIndex ); if (derivedIter == derivedMap.end()) return false; return true; } //! Gets the mapping object that can perform the upcast or downcast /*! Uses the type index from the base and derived class to find the matching registered caster. If no matching caster exists, calls the exception function. The returned PolymorphicCaster is capable of upcasting or downcasting between the two types. */ template inline static std::vector const & lookup( std::type_index const & baseIndex, std::type_index const & derivedIndex, F && exceptionFunc ) { // First phase of lookup - match base type index auto const & baseMap = StaticObject::getInstance().map; auto baseIter = baseMap.find( baseIndex ); if( baseIter == baseMap.end() ) exceptionFunc(); // Second phase - find a match from base to derived auto & derivedMap = baseIter->second; auto derivedIter = derivedMap.find( derivedIndex ); if( derivedIter == derivedMap.end() ) exceptionFunc(); return derivedIter->second; } //! Performs a downcast to the derived type using a registered mapping template inline static const Derived * downcast( const void * dptr, std::type_info const & baseInfo ) { auto const & mapping = lookup( baseInfo, typeid(Derived), [&](){ UNREGISTERED_POLYMORPHIC_CAST_EXCEPTION(save) } ); for( auto const * map : mapping ) dptr = map->downcast( dptr ); return static_cast( dptr ); } //! Performs an upcast to the registered base type using the given a derived type /*! The return is untyped because the final casting to the base type must happen in the polymorphic serialization function, where the type is known at compile time */ template inline static void * upcast( Derived * const dptr, std::type_info const & baseInfo ) { auto const & mapping = lookup( baseInfo, typeid(Derived), [&](){ UNREGISTERED_POLYMORPHIC_CAST_EXCEPTION(load) } ); void * uptr = dptr; for( auto const * map : mapping ) uptr = map->upcast( uptr ); return uptr; } //! Upcasts for shared pointers template inline static std::shared_ptr upcast( std::shared_ptr const & dptr, std::type_info const & baseInfo ) { auto const & mapping = lookup( baseInfo, typeid(Derived), [&](){ UNREGISTERED_POLYMORPHIC_CAST_EXCEPTION(load) } ); std::shared_ptr uptr = dptr; for( auto const * map : mapping ) uptr = map->upcast( uptr ); return uptr; } #undef UNREGISTERED_POLYMORPHIC_CAST_EXCEPTION }; //! Strongly typed derivation of PolymorphicCaster template struct PolymorphicVirtualCaster : PolymorphicCaster { //! Inserts an entry in the polymorphic casting map for this pairing /*! Creates an explicit mapping between Base and Derived in both upwards and downwards directions, allowing void pointers to either to be properly cast assuming dynamic type information is available */ PolymorphicVirtualCaster() { const auto lock = StaticObject::lock(); auto & baseMap = StaticObject::getInstance().map; auto baseKey = std::type_index(typeid(Base)); auto lb = baseMap.lower_bound(baseKey); { auto & derivedMap = baseMap.insert( lb, {baseKey, {}} )->second; auto derivedKey = std::type_index(typeid(Derived)); auto lbd = derivedMap.lower_bound(derivedKey); auto & derivedVec = derivedMap.insert( lbd, { std::move(derivedKey), {}} )->second; derivedVec.push_back( this ); } // Find all chainable unregistered relations std::map>> unregisteredRelations; { auto checkRelation = [](std::type_index const & baseInfo, std::type_index const & derivedInfo) { const bool exists = PolymorphicCasters::exists( baseInfo, derivedInfo ); return std::make_pair( exists, exists ? PolymorphicCasters::lookup( baseInfo, derivedInfo, [](){} ) : std::vector{} ); }; for( auto baseIt : baseMap ) for( auto derivedIt : baseIt.second ) { for( auto otherBaseIt : baseMap ) { if( baseIt.first == otherBaseIt.first ) // only interested in chained relations continue; // Check if there exists a mapping otherBase -> base -> derived that is shorter than // any existing otherBase -> derived direct mapping auto otherBaseItToDerived = checkRelation( otherBaseIt.first, derivedIt.first ); auto baseToDerived = checkRelation( baseIt.first, derivedIt.first ); auto otherBaseToBase = checkRelation( otherBaseIt.first, baseIt.first ); const size_t newLength = otherBaseToBase.second.size() + baseToDerived.second.size(); const bool isShorterOrFirstPath = !otherBaseItToDerived.first || (newLength < derivedIt.second.size()); if( isShorterOrFirstPath && baseToDerived.first && otherBaseToBase.first ) { std::vector path = otherBaseToBase.second; path.insert( path.end(), baseToDerived.second.begin(), baseToDerived.second.end() ); #ifdef CEREAL_OLDER_GCC unregisteredRelations.insert( std::make_pair(otherBaseIt.first, std::pair>{derivedIt.first, std::move(path)}) ); #else // NOT CEREAL_OLDER_GCC unregisteredRelations.emplace( otherBaseIt.first, std::pair>{derivedIt.first, std::move(path)} ); #endif // NOT CEREAL_OLDER_GCC } } // end otherBaseIt } // end derivedIt } // end chain lookup // Insert chained relations for( auto it : unregisteredRelations ) { auto & derivedMap = baseMap.find( it.first )->second; derivedMap[it.second.first] = it.second.second; } } //! Performs the proper downcast with the templated types void const * downcast( void const * const ptr ) const override { return dynamic_cast( static_cast( ptr ) ); } //! Performs the proper upcast with the templated types void * upcast( void * const ptr ) const override { return dynamic_cast( static_cast( ptr ) ); } //! Performs the proper upcast with the templated types (shared_ptr version) std::shared_ptr upcast( std::shared_ptr const & ptr ) const override { return std::dynamic_pointer_cast( std::static_pointer_cast( ptr ) ); } }; //! Registers a polymorphic casting relation between a Base and Derived type /*! Registering a relation allows cereal to properly cast between the two types given runtime type information and void pointers. Registration happens automatically via cereal::base_class and cereal::virtual_base_class instantiations. For cases where neither is called, see the CEREAL_REGISTER_POLYMORPHIC_RELATION macro */ template struct RegisterPolymorphicCaster { static PolymorphicCaster const * bind( std::true_type /* is_polymorphic */) { return &StaticObject>::getInstance(); } static PolymorphicCaster const * bind( std::false_type /* is_polymorphic */ ) { return nullptr; } //! Performs registration (binding) between Base and Derived /*! If the type is not polymorphic, nothing will happen */ static PolymorphicCaster const * bind() { return bind( typename std::is_polymorphic::type() ); } }; } /* General polymorphism support */ namespace detail { //! Binds a compile time type with a user defined string template struct binding_name {}; //! A structure holding a map from type_indices to output serializer functions /*! A static object of this map should be created for each registered archive type, containing entries for every registered type that describe how to properly cast the type to its real type in polymorphic scenarios for shared_ptr, weak_ptr, and unique_ptr. */ template struct OutputBindingMap { //! A serializer function /*! Serializer functions return nothing and take an archive as their first parameter (will be cast properly inside the function, a pointer to actual data (contents of smart_ptr's get() function) as their second parameter, and the type info of the owning smart_ptr as their final parameter */ typedef std::function Serializer; //! Struct containing the serializer functions for all pointer types struct Serializers { Serializer shared_ptr, //!< Serializer function for shared/weak pointers unique_ptr; //!< Serializer function for unique pointers }; //! A map of serializers for pointers of all registered types std::map map; }; //! An empty noop deleter template struct EmptyDeleter { void operator()(T *) const {} }; //! A structure holding a map from type name strings to input serializer functions /*! A static object of this map should be created for each registered archive type, containing entries for every registered type that describe how to properly cast the type to its real type in polymorphic scenarios for shared_ptr, weak_ptr, and unique_ptr. */ template struct InputBindingMap { //! Shared ptr serializer function /*! Serializer functions return nothing and take an archive as their first parameter (will be cast properly inside the function, a shared_ptr (or unique_ptr for the unique case) of any base type, and the type id of said base type as the third parameter. Internally it will properly be loaded and cast to the correct type. */ typedef std::function &, std::type_info const &)> SharedSerializer; //! Unique ptr serializer function typedef std::function> &, std::type_info const &)> UniqueSerializer; //! Struct containing the serializer functions for all pointer types struct Serializers { SharedSerializer shared_ptr; //!< Serializer function for shared/weak pointers UniqueSerializer unique_ptr; //!< Serializer function for unique pointers }; //! A map of serializers for pointers of all registered types std::map map; }; // forward decls for archives from cereal.hpp class InputArchiveBase; class OutputArchiveBase; //! Creates a binding (map entry) between an input archive type and a polymorphic type /*! Bindings are made when types are registered, assuming that at least one archive has already been registered. When this struct is created, it will insert (at run time) an entry into a map that properly handles casting for serializing polymorphic objects */ template struct InputBindingCreator { //! Initialize the binding InputBindingCreator() { auto & map = StaticObject>::getInstance().map; auto lock = StaticObject>::lock(); auto key = std::string(binding_name::name()); auto lb = map.lower_bound(key); if (lb != map.end() && lb->first == key) return; typename InputBindingMap::Serializers serializers; serializers.shared_ptr = [](void * arptr, std::shared_ptr & dptr, std::type_info const & baseInfo) { Archive & ar = *static_cast(arptr); std::shared_ptr ptr; ar( CEREAL_NVP_("ptr_wrapper", ::cereal::memory_detail::make_ptr_wrapper(ptr)) ); dptr = PolymorphicCasters::template upcast( ptr, baseInfo ); }; serializers.unique_ptr = [](void * arptr, std::unique_ptr> & dptr, std::type_info const & baseInfo) { Archive & ar = *static_cast(arptr); std::unique_ptr ptr; ar( CEREAL_NVP_("ptr_wrapper", ::cereal::memory_detail::make_ptr_wrapper(ptr)) ); dptr.reset( PolymorphicCasters::template upcast( ptr.release(), baseInfo )); }; map.insert( lb, { std::move(key), std::move(serializers) } ); } }; //! Creates a binding (map entry) between an output archive type and a polymorphic type /*! Bindings are made when types are registered, assuming that at least one archive has already been registered. When this struct is created, it will insert (at run time) an entry into a map that properly handles casting for serializing polymorphic objects */ template struct OutputBindingCreator { //! Writes appropriate metadata to the archive for this polymorphic type static void writeMetadata(Archive & ar) { // Register the polymorphic type name with the archive, and get the id char const * name = binding_name::name(); std::uint32_t id = ar.registerPolymorphicType(name); // Serialize the id ar( CEREAL_NVP_("polymorphic_id", id) ); // If the msb of the id is 1, then the type name is new, and we should serialize it if( id & detail::msb_32bit ) { std::string namestring(name); ar( CEREAL_NVP_("polymorphic_name", namestring) ); } } //! Holds a properly typed shared_ptr to the polymorphic type class PolymorphicSharedPointerWrapper { public: /*! Wrap a raw polymorphic pointer in a shared_ptr to its true type The wrapped pointer will not be responsible for ownership of the held pointer so it will not attempt to destroy it; instead the refcount of the wrapped pointer will be tied to a fake 'ownership pointer' that will do nothing when it ultimately goes out of scope. The main reason for doing this, other than not to destroy the true object with our wrapper pointer, is to avoid meddling with the internal reference count in a polymorphic type that inherits from std::enable_shared_from_this. @param dptr A void pointer to the contents of the shared_ptr to serialize */ PolymorphicSharedPointerWrapper( T const * dptr ) : refCount(), wrappedPtr( refCount, dptr ) { } //! Get the wrapped shared_ptr */ inline std::shared_ptr const & operator()() const { return wrappedPtr; } private: std::shared_ptr refCount; //!< The ownership pointer std::shared_ptr wrappedPtr; //!< The wrapped pointer }; //! Does the actual work of saving a polymorphic shared_ptr /*! This function will properly create a shared_ptr from the void * that is passed in before passing it to the archive for serialization. In addition, this will also preserve the state of any internal enable_shared_from_this mechanisms @param ar The archive to serialize to @param dptr Pointer to the actual data held by the shared_ptr */ static inline void savePolymorphicSharedPtr( Archive & ar, T const * dptr, std::true_type /* has_shared_from_this */ ) { ::cereal::memory_detail::EnableSharedStateHelper state( const_cast(dptr) ); PolymorphicSharedPointerWrapper psptr( dptr ); ar( CEREAL_NVP_("ptr_wrapper", memory_detail::make_ptr_wrapper( psptr() ) ) ); } //! Does the actual work of saving a polymorphic shared_ptr /*! This function will properly create a shared_ptr from the void * that is passed in before passing it to the archive for serialization. This version is for types that do not inherit from std::enable_shared_from_this. @param ar The archive to serialize to @param dptr Pointer to the actual data held by the shared_ptr */ static inline void savePolymorphicSharedPtr( Archive & ar, T const * dptr, std::false_type /* has_shared_from_this */ ) { PolymorphicSharedPointerWrapper psptr( dptr ); ar( CEREAL_NVP_("ptr_wrapper", memory_detail::make_ptr_wrapper( psptr() ) ) ); } //! Initialize the binding OutputBindingCreator() { auto & map = StaticObject>::getInstance().map; auto key = std::type_index(typeid(T)); auto lb = map.lower_bound(key); if (lb != map.end() && lb->first == key) return; typename OutputBindingMap::Serializers serializers; serializers.shared_ptr = [&](void * arptr, void const * dptr, std::type_info const & baseInfo) { Archive & ar = *static_cast(arptr); writeMetadata(ar); auto ptr = PolymorphicCasters::template downcast( dptr, baseInfo ); #ifdef _MSC_VER savePolymorphicSharedPtr( ar, ptr, ::cereal::traits::has_shared_from_this::type() ); // MSVC doesn't like typename here #else // not _MSC_VER savePolymorphicSharedPtr( ar, ptr, typename ::cereal::traits::has_shared_from_this::type() ); #endif // _MSC_VER }; serializers.unique_ptr = [&](void * arptr, void const * dptr, std::type_info const & baseInfo) { Archive & ar = *static_cast(arptr); writeMetadata(ar); std::unique_ptr> const ptr( PolymorphicCasters::template downcast( dptr, baseInfo ) ); ar( CEREAL_NVP_("ptr_wrapper", memory_detail::make_ptr_wrapper(ptr)) ); }; map.insert( { std::move(key), std::move(serializers) } ); } }; //! Used to help out argument dependent lookup for finding potential overloads //! of instantiate_polymorphic_binding struct adl_tag {}; //! Tag for init_binding, bind_to_archives and instantiate_polymorphic_binding. Due to the use of anonymous //! namespace it becomes a different type in each translation unit. namespace { struct polymorphic_binding_tag {}; } //! Causes the static object bindings between an archive type and a serializable type T template struct create_bindings { static const InputBindingCreator & load(std::true_type) { return cereal::detail::StaticObject>::getInstance(); } static const OutputBindingCreator & save(std::true_type) { return cereal::detail::StaticObject>::getInstance(); } inline static void load(std::false_type) {} inline static void save(std::false_type) {} }; //! When specialized, causes the compiler to instantiate its parameter template struct instantiate_function {}; /*! This struct is used as the return type of instantiate_polymorphic_binding for specific Archive types. When the compiler looks for overloads of instantiate_polymorphic_binding, it will be forced to instantiate this struct during overload resolution, even though it will not be part of a valid overload */ template struct polymorphic_serialization_support { #if defined(_MSC_VER) && !defined(__INTEL_COMPILER) //! Creates the appropriate bindings depending on whether the archive supports //! saving or loading virtual CEREAL_DLL_EXPORT void instantiate() CEREAL_USED; #else // NOT _MSC_VER //! Creates the appropriate bindings depending on whether the archive supports //! saving or loading static CEREAL_DLL_EXPORT void instantiate() CEREAL_USED; //! This typedef causes the compiler to instantiate this static function typedef instantiate_function unused; #endif // _MSC_VER }; // instantiate implementation template CEREAL_DLL_EXPORT void polymorphic_serialization_support::instantiate() { create_bindings::save( std::integral_constant::value && traits::is_output_serializable::value>{} ); create_bindings::load( std::integral_constant::value && traits::is_input_serializable::value>{} ); } //! Begins the binding process of a type to all registered archives /*! Archives need to be registered prior to this struct being instantiated via the CEREAL_REGISTER_ARCHIVE macro. Overload resolution will then force several static objects to be made that allow us to bind together all registered archive types with the parameter type T. */ template struct bind_to_archives { //! Binding for non abstract types void bind(std::false_type) const { instantiate_polymorphic_binding((T*) 0, 0, Tag{}, adl_tag{}); } //! Binding for abstract types void bind(std::true_type) const { } //! Binds the type T to all registered archives /*! If T is abstract, we will not serialize it and thus do not need to make a binding */ bind_to_archives const & bind() const { static_assert( std::is_polymorphic::value, "Attempting to register non polymorphic type" ); bind( std::is_abstract() ); return *this; } }; //! Used to hide the static object used to bind T to registered archives template struct init_binding; //! Base case overload for instantiation /*! This will end up always being the best overload due to the second parameter always being passed as an int. All other overloads will accept pointers to archive types and have lower precedence than int. Since the compiler needs to check all possible overloads, the other overloads created via CEREAL_REGISTER_ARCHIVE, which will have lower precedence due to requring a conversion from int to (Archive*), will cause their return types to be instantiated through the static object mechanisms even though they are never called. See the documentation for the other functions to try and understand this */ template void instantiate_polymorphic_binding( T*, int, BindingTag, adl_tag ) {} } // namespace detail } // namespace cereal #endif // CEREAL_DETAILS_POLYMORPHIC_IMPL_HPP_