#ifndef NETGEN_CORE_ARCHIVE_HPP #define NETGEN_CORE_ARCHIVE_HPP #include // for complex #include // for size_t, strlen #include // for operator<<, ifstream, ofstream, basic... #include // for function #include // for map, _Rb_tree_iterator #include // for __shared_ptr_access, __shared_ptr_acc... #include // for runtime_error #include // for string, operator+ #include // for declval, enable_if, false_type, is_co... #include // for type_info #include // for move, swap, pair #include // for vector #include "ngcore_api.hpp" // for NGCORE_API, unlikely #include "type_traits.hpp" // for all_of_tmpl #include "version.hpp" // for VersionInfo #ifdef NG_PYTHON #include #endif // NG_PYTHON namespace ngcore { // Libraries using this archive can store their version here to implement backwards compatibility NGCORE_API const VersionInfo& GetLibraryVersion(const std::string& library); NGCORE_API void SetLibraryVersion(const std::string& library, const VersionInfo& version); NGCORE_API std::string Demangle(const char* typeinfo); class NGCORE_API Archive; namespace detail { // create new pointer of type T if it is default constructible, else throw template T* constructIfPossible_impl(Rest... /*unused*/) { throw std::runtime_error(std::string(Demangle(typeid(T).name())) + " is not default constructible!"); } template::value>::type> T* constructIfPossible_impl(int /*unused*/) { return new T; } // NOLINT template T* constructIfPossible() { return constructIfPossible_impl(int{}); } //Type trait to check if a class implements a 'void DoArchive(Archive&)' function template struct has_DoArchive { private: template static constexpr auto check(T2*) -> typename std::is_same().DoArchive(std::declval())),void>::type; template static constexpr std::false_type check(...); using type = decltype(check(nullptr)); // NOLINT public: NGCORE_API static constexpr bool value = type::value; }; // Check if class is archivable template struct is_Archivable_struct { private: template static constexpr auto check(T2*) -> typename std::is_same() & std::declval()),Archive&>::type; template static constexpr std::false_type check(...); using type = decltype(check(nullptr)); // NOLINT public: NGCORE_API static constexpr bool value = type::value; }; struct ClassArchiveInfo { // create new object of this type and return a void* pointer that is points to the location // of the (base)class given by type_info std::function creator; // This caster takes a void* pointer to the type stored in this info and casts it to a // void* pointer pointing to the (base)class type_info std::function upcaster; // This caster takes a void* pointer to the (base)class type_info and returns void* pointing // to the type stored in this info std::function downcaster; }; } // namespace detail template constexpr bool is_archivable = detail::is_Archivable_struct::value; // Base Archive class class NGCORE_API Archive { const bool is_output; // how many different shared_ptr/pointer have been (un)archived int shared_ptr_count, ptr_count; // maps for archived shared pointers and pointers std::map shared_ptr2nr, ptr2nr; // vectors for storing the unarchived (shared) pointers std::vector> nr2shared_ptr; std::vector nr2ptr; protected: bool shallow_to_python = false; public: Archive() = delete; Archive(const Archive&) = delete; Archive(Archive&&) = delete; Archive (bool ais_output) : is_output(ais_output), shared_ptr_count(0), ptr_count(0) { ; } virtual ~Archive() { ; } template Archive& Shallow(T& val) { static_assert(detail::is_any_pointer, "ShallowArchive must be given pointer type!"); #ifdef NG_PYTHON if(shallow_to_python) { if(is_output) ShallowOutPython(pybind11::cast(val)); else val = pybind11::cast(ShallowInPython()); } else #endif // NG_PYTHON *this & val; return *this; } #ifdef NG_PYTHON virtual void ShallowOutPython(pybind11::object /*unused*/) // NOLINT (copy by val is ok for this virt func) { throw std::runtime_error("Should not get in ShallowToPython base class implementation!"); } virtual pybind11::object ShallowInPython() { throw std::runtime_error("Should not get in ShallowFromPython base class implementation!"); } #endif // NG_PYTHON Archive& operator=(const Archive&) = delete; Archive& operator=(Archive&&) = delete; bool Output () const { return is_output; } bool Input () const { return !is_output; } virtual const VersionInfo& GetVersion(const std::string& library) { return GetLibraryVersions()[library]; } // Pure virtual functions that have to be implemented by In-/OutArchive virtual Archive & operator & (double & d) = 0; virtual Archive & operator & (int & i) = 0; virtual Archive & operator & (long & i) = 0; virtual Archive & operator & (size_t & i) = 0; virtual Archive & operator & (short & i) = 0; virtual Archive & operator & (unsigned char & i) = 0; virtual Archive & operator & (bool & b) = 0; virtual Archive & operator & (std::string & str) = 0; virtual Archive & operator & (char *& str) = 0; virtual Archive & operator & (VersionInfo & version) { if(Output()) (*this) << version.to_string(); else { std::string s; (*this) & s; version = VersionInfo(s); } return *this; } // Archive std classes ================================================ template Archive& operator & (std::complex& c) { if(Output()) (*this) << c.real() << c.imag(); else { T tmp; (*this) & tmp; c.real(tmp); (*this) & tmp; c.imag(tmp); } return (*this); } template Archive& operator & (std::vector& v) { size_t size; if(Output()) size = v.size(); (*this) & size; if(Input()) v.resize(size); Do(&v[0], size); return (*this); } template Archive& operator& (std::map& map) { if(Output()) { (*this) << size_t(map.size()); for(auto& pair : map) (*this) << pair.first << pair.second; } else { size_t size = 0; (*this) & size; T1 key; T2 val; for(size_t i = 0; i < size; i++) { T1 key; T2 val; (*this) & key & val; map[key] = val; } } return (*this); } // Archive arrays ===================================================== // this functions can be overloaded in Archive implementations for more efficiency template >::type> Archive & Do (T * data, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & data[j]; }; return *this; }; // NOLINT virtual Archive & Do (double * d, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & d[j]; }; return *this; }; // NOLINT virtual Archive & Do (int * i, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & i[j]; }; return *this; }; // NOLINT virtual Archive & Do (long * i, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & i[j]; }; return *this; }; // NOLINT virtual Archive & Do (size_t * i, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & i[j]; }; return *this; }; // NOLINT virtual Archive & Do (short * i, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & i[j]; }; return *this; }; // NOLINT virtual Archive & Do (unsigned char * i, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & i[j]; }; return *this; }; // NOLINT virtual Archive & Do (bool * b, size_t n) { for (size_t j = 0; j < n; j++) { (*this) & b[j]; }; return *this; }; // NOLINT // Archive a class implementing a (void DoArchive(Archive&)) method ======= template::value>> Archive& operator & (T& val) { val.DoArchive(*this); return *this; } // Archive shared_ptrs ================================================= template Archive& operator & (std::shared_ptr& ptr) { if(Output()) { // save -2 for nullptr if(!ptr) return (*this) << -2; void* reg_ptr = ptr.get(); bool neededDowncast = false; // Downcasting is only possible for our registered classes if(typeid(T) != typeid(*ptr)) { if(!IsRegistered(Demangle(typeid(*ptr).name()))) throw std::runtime_error(std::string("Archive error: Polymorphic type ") + Demangle(typeid(*ptr).name()) + " not registered for archive"); reg_ptr = GetArchiveRegister(Demangle(typeid(*ptr).name())).downcaster(typeid(T), ptr.get()); // if there was a true downcast we have to store more information if(reg_ptr != static_cast(ptr.get()) ) neededDowncast = true; } auto pos = shared_ptr2nr.find(reg_ptr); // if not found store -1 and the pointer if(pos == shared_ptr2nr.end()) { auto p = ptr.get(); (*this) << -1; (*this) & neededDowncast & p; // if we did downcast we store the true type as well if(neededDowncast) (*this) << Demangle(typeid(*ptr).name()); shared_ptr2nr[reg_ptr] = shared_ptr_count++; return *this; } // if found store the position and if it has to be downcasted and how (*this) << pos->second << neededDowncast; if(neededDowncast) (*this) << Demangle(typeid(*ptr).name()); } else // Input { int nr; (*this) & nr; // -2 restores a nullptr if(nr == -2) { ptr = nullptr; return *this; } // -1 restores a new shared ptr by restoring the inner pointer and creating a shared_ptr to it if (nr == -1) { T* p = nullptr; bool neededDowncast; (*this) & neededDowncast & p; ptr = std::shared_ptr(p); // if we did downcast we need to store a shared_ptr to the true object if(neededDowncast) { std::string name; (*this) & name; auto info = GetArchiveRegister(name); // for this we use an aliasing constructor to create a shared pointer sharing lifetime // with our shared ptr, but pointing to the true object nr2shared_ptr.push_back(std::shared_ptr(std::static_pointer_cast(ptr), info.downcaster(typeid(T), ptr.get()))); } else nr2shared_ptr.push_back(ptr); } else { auto other = nr2shared_ptr[nr]; bool neededDowncast; (*this) & neededDowncast; if(neededDowncast) { // if there was a downcast we can expect the class to be registered (since archiving // wouldn't have worked else) std::string name; (*this) & name; auto info = GetArchiveRegister(name); // same trick as above, create a shared ptr sharing lifetime with // the shared_ptr in the register, but pointing to our object ptr = std::static_pointer_cast(std::shared_ptr(other, info.upcaster(typeid(T), other.get()))); } else ptr = std::static_pointer_cast(other); } } return *this; } // Archive pointers ======================================================= template Archive & operator& (T *& p) { if (Output()) { // if the pointer is null store -2 if (!p) return (*this) << -2; auto reg_ptr = static_cast(p); if(typeid(T) != typeid(*p)) { if(!IsRegistered(Demangle(typeid(*p).name()))) throw std::runtime_error(std::string("Archive error: Polymorphic type ") + Demangle(typeid(*p).name()) + " not registered for archive"); reg_ptr = GetArchiveRegister(Demangle(typeid(*p).name())).downcaster(typeid(T), static_cast(p)); } auto pos = ptr2nr.find(reg_ptr); // if the pointer is not found in the map create a new entry if (pos == ptr2nr.end()) { ptr2nr[reg_ptr] = ptr_count++; if(typeid(*p) == typeid(T)) if (std::is_constructible::value) { return (*this) << -1 & (*p); } else throw std::runtime_error(std::string("Archive error: Class ") + Demangle(typeid(*p).name()) + " does not provide a default constructor!"); else { // if a pointer to a base class is archived, the class hierarchy must be registered // to avoid compile time issues we allow this behaviour only for "our" classes that // implement a void DoArchive(Archive&) member function // To recreate the object we need to store the true type of it if(!IsRegistered(Demangle(typeid(*p).name()))) throw std::runtime_error(std::string("Archive error: Polymorphic type ") + Demangle(typeid(*p).name()) + " not registered for archive"); return (*this) << -3 << Demangle(typeid(*p).name()) & (*p); } } else { (*this) & pos->second; bool downcasted = !(reg_ptr == static_cast(p) ); // store if the class has been downcasted and the name (*this) << downcasted << Demangle(typeid(*p).name()); } } else { int nr; (*this) & nr; if (nr == -2) // restore a nullptr p = nullptr; else if (nr == -1) // create a new pointer of standard type (no virtual or multiple inheritance,...) { p = detail::constructIfPossible(); nr2ptr.push_back(p); (*this) & *p; } else if(nr == -3) // restore one of our registered classes that can have multiple inheritance,... { // As stated above, we want this special behaviour only for our classes that implement DoArchive std::string name; (*this) & name; auto info = GetArchiveRegister(name); // the creator creates a new object of type name, and returns a void* pointing // to T (which may have an offset) p = static_cast(info.creator(typeid(T))); // we store the downcasted pointer (to be able to find it again from // another class in a multiple inheritance tree) nr2ptr.push_back(info.downcaster(typeid(T),p)); (*this) & *p; } else { bool downcasted; std::string name; (*this) & downcasted & name; if(downcasted) { // if the class has been downcasted we can assume it is in the register auto info = GetArchiveRegister(name); p = static_cast(info.upcaster(typeid(T), nr2ptr[nr])); } else p = static_cast(nr2ptr[nr]); } } return *this; } // const ptr template Archive& operator &(const T*& t) { return (*this) & const_cast(t); // NOLINT } // Write a read only variable template Archive & operator << (const T & t) { T ht(t); (*this) & ht; return *this; } virtual void FlushBuffer() {} protected: static std::map& GetLibraryVersions(); private: template friend class RegisterClassForArchive; // Returns ClassArchiveInfo of Demangled typeid static const detail::ClassArchiveInfo& GetArchiveRegister(const std::string& classname); // Set ClassArchiveInfo for Demangled typeid, this is done by creating an instance of // RegisterClassForArchive static void SetArchiveRegister(const std::string& classname, const detail::ClassArchiveInfo& info); static bool IsRegistered(const std::string& classname); // Helper class for up-/downcasting template struct Caster{}; template struct Caster { static void* tryUpcast (const std::type_info& /*unused*/, T* /*unused*/) { throw std::runtime_error("Upcast not successful, some classes are not registered properly for archiving!"); } static void* tryDowncast (const std::type_info& /*unused*/, void* /*unused*/) { throw std::runtime_error("Downcast not successful, some classes are not registered properly for archiving!"); } }; template struct Caster { static void* tryUpcast(const std::type_info& ti, T* p) { try { return GetArchiveRegister(Demangle(typeid(B1).name())). upcaster(ti, static_cast(dynamic_cast(p))); } catch(std::exception&) { return Caster::tryUpcast(ti, p); } } static void* tryDowncast(const std::type_info& ti, void* p) { if(typeid(B1) == ti) return dynamic_cast(static_cast(p)); try { return dynamic_cast(static_cast(GetArchiveRegister(Demangle(typeid(B1).name())). downcaster(ti, p))); } catch(std::exception&) { return Caster::tryDowncast(ti, p); } } }; }; template class RegisterClassForArchive { public: RegisterClassForArchive() { static_assert(detail::all_of_tmpl::value...>, "Variadic template arguments must be base classes of T"); detail::ClassArchiveInfo info; info.creator = [this,&info](const std::type_info& ti) -> void* { return typeid(T) == ti ? detail::constructIfPossible() : Archive::Caster::tryUpcast(ti, detail::constructIfPossible()); }; info.upcaster = [this](const std::type_info& ti, void* p) -> void* { return typeid(T) == ti ? p : Archive::Caster::tryUpcast(ti, static_cast(p)); }; info.downcaster = [this](const std::type_info& ti, void* p) -> void* { return typeid(T) == ti ? p : Archive::Caster::tryDowncast(ti, p); }; Archive::SetArchiveRegister(std::string(Demangle(typeid(T).name())),info); } }; // BinaryOutArchive ====================================================================== class NGCORE_API BinaryOutArchive : public Archive { static constexpr size_t BUFFERSIZE = 1024; char buffer[BUFFERSIZE] = {}; size_t ptr = 0; protected: std::shared_ptr stream; public: BinaryOutArchive() = delete; BinaryOutArchive(const BinaryOutArchive&) = delete; BinaryOutArchive(BinaryOutArchive&&) = delete; BinaryOutArchive(std::shared_ptr&& astream) : Archive(true), stream(std::move(astream)) { } BinaryOutArchive(const std::string& filename) : BinaryOutArchive(std::make_shared(filename)) {} ~BinaryOutArchive () override { FlushBuffer(); } BinaryOutArchive& operator=(const BinaryOutArchive&) = delete; BinaryOutArchive& operator=(BinaryOutArchive&&) = delete; using Archive::operator&; Archive & operator & (double & d) override { return Write(d); } Archive & operator & (int & i) override { return Write(i); } Archive & operator & (short & i) override { return Write(i); } Archive & operator & (long & i) override { return Write(i); } Archive & operator & (size_t & i) override { return Write(i); } Archive & operator & (unsigned char & i) override { return Write(i); } Archive & operator & (bool & b) override { return Write(b); } Archive & operator & (std::string & str) override { int len = str.length(); (*this) & len; FlushBuffer(); if(len) stream->write (&str[0], len); return *this; } Archive & operator & (char *& str) override { long len = str ? strlen (str) : -1; (*this) & len; FlushBuffer(); if(len > 0) stream->write (&str[0], len); // NOLINT return *this; } void FlushBuffer() override { if (ptr > 0) { stream->write(&buffer[0], ptr); ptr = 0; } } private: template Archive & Write (T x) { if (unlikely(ptr > BUFFERSIZE-sizeof(T))) { stream->write(&buffer[0], ptr); *reinterpret_cast(&buffer[0]) = x; // NOLINT ptr = sizeof(T); return *this; } *reinterpret_cast(&buffer[ptr]) = x; // NOLINT ptr += sizeof(T); return *this; } }; // BinaryInArchive ====================================================================== class NGCORE_API BinaryInArchive : public Archive { protected: std::shared_ptr stream; public: BinaryInArchive (std::shared_ptr&& astream) : Archive(false), stream(std::move(astream)) { } BinaryInArchive (const std::string& filename) : BinaryInArchive(std::make_shared(filename)) { ; } using Archive::operator&; Archive & operator & (double & d) override { Read(d); return *this; } Archive & operator & (int & i) override { Read(i); return *this; } Archive & operator & (short & i) override { Read(i); return *this; } Archive & operator & (long & i) override { Read(i); return *this; } Archive & operator & (size_t & i) override { Read(i); return *this; } Archive & operator & (unsigned char & i) override { Read(i); return *this; } Archive & operator & (bool & b) override { Read(b); return *this; } Archive & operator & (std::string & str) override { int len; (*this) & len; str.resize(len); if(len) stream->read(&str[0], len); // NOLINT return *this; } Archive & operator & (char *& str) override { long len; (*this) & len; if(len == -1) str = nullptr; else { str = new char[len+1]; // NOLINT stream->read(&str[0], len); // NOLINT str[len] = '\0'; // NOLINT } return *this; } Archive & Do (double * d, size_t n) override { stream->read(reinterpret_cast(d), n*sizeof(double)); return *this; } // NOLINT Archive & Do (int * i, size_t n) override { stream->read(reinterpret_cast(i), n*sizeof(int)); return *this; } // NOLINT Archive & Do (size_t * i, size_t n) override { stream->read(reinterpret_cast(i), n*sizeof(size_t)); return *this; } // NOLINT private: template inline void Read(T& val) { stream->read(reinterpret_cast(&val), sizeof(T)); } // NOLINT }; // TextOutArchive ====================================================================== class NGCORE_API TextOutArchive : public Archive { protected: std::shared_ptr stream; public: TextOutArchive (std::shared_ptr&& astream) : Archive(true), stream(std::move(astream)) { } TextOutArchive (const std::string& filename) : TextOutArchive(std::make_shared(filename)) { } using Archive::operator&; Archive & operator & (double & d) override { *stream << d << '\n'; return *this; } Archive & operator & (int & i) override { *stream << i << '\n'; return *this; } Archive & operator & (short & i) override { *stream << i << '\n'; return *this; } Archive & operator & (long & i) override { *stream << i << '\n'; return *this; } Archive & operator & (size_t & i) override { *stream << i << '\n'; return *this; } Archive & operator & (unsigned char & i) override { *stream << int(i) << '\n'; return *this; } Archive & operator & (bool & b) override { *stream << (b ? 't' : 'f') << '\n'; return *this; } Archive & operator & (std::string & str) override { int len = str.length(); *stream << len << '\n'; if(len) { stream->write(&str[0], len); // NOLINT *stream << '\n'; } return *this; } Archive & operator & (char *& str) override { long len = str ? strlen (str) : -1; *this & len; if(len > 0) { stream->write (&str[0], len); // NOLINT *stream << '\n'; } return *this; } }; // TextInArchive ====================================================================== class NGCORE_API TextInArchive : public Archive { protected: std::shared_ptr stream; public: TextInArchive (std::shared_ptr&& astream) : Archive(false), stream(std::move(astream)) { } TextInArchive (const std::string& filename) : TextInArchive(std::make_shared(filename)) {} using Archive::operator&; Archive & operator & (double & d) override { *stream >> d; return *this; } Archive & operator & (int & i) override { *stream >> i; return *this; } Archive & operator & (short & i) override { *stream >> i; return *this; } Archive & operator & (long & i) override { *stream >> i; return *this; } Archive & operator & (size_t & i) override { *stream >> i; return *this; } Archive & operator & (unsigned char & i) override { int _i; *stream >> _i; i = _i; return *this; } Archive & operator & (bool & b) override { char c; *stream >> c; b = (c=='t'); return *this; } Archive & operator & (std::string & str) override { int len; *stream >> len; char ch; stream->get(ch); // '\n' str.resize(len); if(len) stream->get(&str[0], len+1, '\0'); return *this; } Archive & operator & (char *& str) override { long len; (*this) & len; char ch; if(len == -1) { str = nullptr; return (*this); } str = new char[len+1]; // NOLINT if(len) { stream->get(ch); // \n stream->get(&str[0], len+1, '\0'); // NOLINT } str[len] = '\0'; // NOLINT return *this; } }; #ifdef NG_PYTHON template class PyArchive : public ARCHIVE { private: pybind11::list lst; size_t index = 0; using ARCHIVE::stream; public: PyArchive(const pybind11::object& alst = pybind11::none()) : ARCHIVE(std::make_shared()), lst(alst.is_none() ? pybind11::list() : pybind11::cast(alst)) { ARCHIVE::shallow_to_python = true; if(Input()) stream = std::make_shared (pybind11::cast(lst[pybind11::len(lst)-1])); } using ARCHIVE::Output; using ARCHIVE::Input; using ARCHIVE::FlushBuffer; using ARCHIVE::operator&; using ARCHIVE::operator<<; using ARCHIVE::GetVersion; void ShallowOutPython(pybind11::object val) override { lst.append(val); } pybind11::object ShallowInPython() override { return lst[index++]; } pybind11::list WriteOut() { FlushBuffer(); lst.append(pybind11::bytes(std::static_pointer_cast(stream)->str())); return lst; } }; template auto NGSPickle(bool printoutput=false) { return pybind11::pickle([printoutput](T* self) { PyArchive ar; ar & self; auto output = pybind11::make_tuple(ar.WriteOut()); if(printoutput) pybind11::print("pickle output of", Demangle(typeid(T).name()),"=", output); return output; }, [](pybind11::tuple state) { T* val = nullptr; PyArchive ar(state[0]); ar & val; return val; }); } #endif // NG_PYTHON } // namespace ngcore #endif // NETGEN_CORE_ARCHIVE_HPP