Ticket #3108: osx-libcpp-serialization-fixes.patch

source/lib/file/common/trace.cpp

@@ -1 @@
-/* Copyright (c) 2010 Wildfire Games
+/* Copyright (c) 2015 Wildfire Games
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -80 +80 @@
     stream >> m_size;
 
     ENSURE(stream.get() == '\n');
-    ENSURE(stream.good());
+    // NOTE: Don't use good() here - it fails due to a bug in older libc++ versions
+    ENSURE(!stream.bad() && !stream.fail());
     ENSURE(stream.get() == WEOF);
 }
 

source/simulation2/serialization/BinarySerializer.h

@@ -35 +35 @@
 {
     NONCOPYABLE(CSerializerStreamBuf);
     T& m_SerializerImpl;
+    char m_Buffer[16];
 public:
     CSerializerStreamBuf(T& impl) :
         m_SerializerImpl(impl)
     {
+        setp(m_Buffer, m_Buffer + ARRAY_SIZE(m_Buffer) - 1);
     }
 
+protected:
+    // Override overflow and sync, because older versions of libc++ streams
+    // write strings as individual characters, then xsputn is never called
+    int overflow(int ch)
+    {
+        if (ch == traits_type::eof())
+            return traits_type::not_eof(ch);
+        
+        ENSURE(pptr() <= epptr());
+        *pptr() = ch;
+        pbump(1);
+        sync();
+        return ch;
+    }
+
+    int sync()
+    {
+        std::ptrdiff_t n = pptr() - pbase();
+        if (n != 0)
+        {
+            pbump(-n);
+            m_SerializerImpl.Put("stream", reinterpret_cast<const u8*> (pbase()), n);
+        }
+        return 0;
+    }
+
     std::streamsize xsputn(const char* s, std::streamsize n)
     {
         m_SerializerImpl.Put("stream", reinterpret_cast<const u8*> (s), n);

source/simulation2/serialization/StdDeserializer.cpp

@@ -84 +84 @@
     if (!m_Stream.good())
     {
         // hit eof before len, or other errors
-        // Note: older libc++ versions incorrectly set eofbit on the last char; test gcount as a workaround
+        // NOTE: older libc++ versions incorrectly set eofbit on the last char; test gcount as a workaround
         // see https://llvm.org/bugs/show_bug.cgi?id=9335
         if (m_Stream.bad() || m_Stream.fail() || (m_Stream.eof() && m_Stream.gcount() != (std::streamsize)len))
             throw PSERROR_Deserialize_ReadFailed();

source/simulation2/serialization/StdSerializer.cpp

@@ -1 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -22 +22 @@
 CStdSerializerImpl::CStdSerializerImpl(std::ostream& stream) :
     m_Stream(stream)
 {
+    m_Stream << std::unitbuf;
 }
 
 CStdSerializer::CStdSerializer(ScriptInterface& scriptInterface, std::ostream& stream) :

source/simulation2/system/ComponentManagerSerialization.cpp

@@ -97 +97 @@
 
 bool CComponentManager::ComputeStateHash(std::string& outHash, bool quick)
 {
+    TIMER(L"ComputeStateHash");
     // Hash serialization: this includes the minimal data necessary to detect
     // differences in the state, and ignores things like counts and names
 

source/simulation2/tests/test_Serializer.h

@@ -167 +167 @@
         deserialize.NumberI32("z", n, 0, 65535);
         TS_ASSERT_EQUALS(n, 12345);
 
-        TS_ASSERT(stream.good());
+        // NOTE: Don't use good() here - it fails due to a bug in older libc++ versions
+        TS_ASSERT(!stream.bad() && !stream.fail());
         TS_ASSERT_EQUALS(stream.peek(), EOF);
     }
 
@@ -233 +234 @@
         deserialize.RawBytes("raw bytes", cbuf, 6);
         TS_ASSERT_SAME_DATA(cbuf, (const u8*)"\0\1\2\3\x0f\x10\x42", 7);
 
-        TS_ASSERT(stream.good());
+        // NOTE: Don't use good() here - it fails due to a bug in older libc++ versions
+        TS_ASSERT(!stream.bad() && !stream.fail());
         TS_ASSERT_EQUALS(stream.peek(), EOF);
     }
 
@@ -248 +250 @@
 
         TS_ASSERT_EQUALS(serialize.GetHashLength(), (size_t)16);
         TS_ASSERT_SAME_DATA(serialize.ComputeHash(), "\xa0\x3a\xe5\x3e\x9b\xd7\xfb\x11\x88\x35\xc6\xfb\xb9\x94\xa9\x72", 16);
-        // echo -en "\x85\xff\xff\xff\xd2\x04\x00\x00\x39\x30\x00\x00" | openssl md5 | perl -pe 's/(..)/\\x$1/g'
+        // echo -en "\x85\xff\xff\xff\xd2\x04\x00\x00\x39\x30\x00\x00" | openssl md5 -binary | xxd -p | perl -pe 's/(..)/\\x$1/g'
     }
 
+    void test_Hash_stream()
+    {
+        ScriptInterface script("Test", "Test", g_ScriptRuntime);
+        CHashSerializer hashSerialize(script);
+
+        hashSerialize.NumberI32_Unbounded("x", -123);
+        hashSerialize.NumberU32_Unbounded("y", 1234);
+        hashSerialize.NumberI32("z", 12345, 0, 65535);
+
+        ISerializer& serialize = hashSerialize;
+        CStdSerializer streamSerialize(script, serialize.GetStream());
+
+        streamSerialize.NumberI32_Unbounded("x2", -456);
+        streamSerialize.NumberU32_Unbounded("y2", 5678);
+        streamSerialize.NumberI32("z2", 45678, 0, 65535);
+
+        TS_ASSERT_EQUALS(hashSerialize.GetHashLength(), (size_t)16);
+        TS_ASSERT_SAME_DATA(hashSerialize.ComputeHash(), "\x5c\xff\x33\xd1\x72\xdd\x6d\x77\xa8\xd4\xa1\xf6\x84\xcc\xaa\x10", 16);
+        // echo -en "\x85\xff\xff\xff\xd2\x04\x00\x00\x39\x30\x00\x00\x38\xfe\xff\xff\x2e\x16\x00\x00\x6e\xb2\x00\x00" | openssl md5 -binary | xxd -p | perl -pe 's/(..)/\\x$1/g'
+    }
+
     void test_bounds()
     {
         ScriptInterface script("Test", "Test", g_ScriptRuntime);
@@ -295 +318 @@
 
         JS::RootedValue newobj(cx);
         deserialize.ScriptVal("script", &newobj);
-        TSM_ASSERT(msg, stream.good());
+        // NOTE: Don't use good() here - it fails due to a bug in older libc++ versions
+        TSM_ASSERT(msg, !stream.bad() && !stream.fail());
         TSM_ASSERT_EQUALS(msg, stream.peek(), EOF);
 
         std::string source;
@@ -769 +793 @@
 
             JS::RootedValue newobj(cx);
             deserialize.ScriptVal("script", &newobj);
-            TS_ASSERT(stream.good());
+            // NOTE: Don't use good() here - it fails due to a bug in older libc++ versions
+            TS_ASSERT(!stream.bad() && !stream.fail());
             TS_ASSERT_EQUALS(stream.peek(), EOF);
 
             if (i == 0)