]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/serialization.cpp
Don't include client/game.h on server build
[dragonfireclient.git] / src / serialization.cpp
index f150d45f05edd150b253fbd4184d43fad117f566..11164a0ede10952f78b174a008f8df7996dfceaa 100644 (file)
@@ -1,32 +1,32 @@
 /*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
 #include "serialization.h"
-#include "utility.h"
-#ifdef _WIN32
-       #define ZLIB_WINAPI
-#endif
-#include "zlib.h"
+
+#include "util/serialize.h"
+
+#include <zlib.h>
+#include <zstd.h>
 
 /* report a zlib or i/o error */
 void zerr(int ret)
-{   
+{
     dstream<<"zerr: ";
     switch (ret) {
     case Z_ERRNO:
@@ -52,13 +52,11 @@ void zerr(int ret)
     }
 }
 
-void compressZlib(SharedBuffer<u8> data, std::ostream &os)
+void compressZlib(const u8 *data, size_t data_size, std::ostream &os, int level)
 {
        z_stream z;
        const s32 bufsize = 16384;
-       //char input_buffer[bufsize];
        char output_buffer[bufsize];
-       int input_i = 0;
        int status = 0;
        int ret;
 
@@ -66,30 +64,20 @@ void compressZlib(SharedBuffer<u8> data, std::ostream &os)
        z.zfree = Z_NULL;
        z.opaque = Z_NULL;
 
-       ret = deflateInit(&z, -1);
+       ret = deflateInit(&z, level);
        if(ret != Z_OK)
                throw SerializationError("compressZlib: deflateInit failed");
-       
-       z.avail_in = 0;
-       
+
+       // Point zlib to our input buffer
+       z.next_in = (Bytef*)&data[0];
+       z.avail_in = data_size;
+       // And get all output
        for(;;)
        {
-               int flush = Z_NO_FLUSH;
                z.next_out = (Bytef*)output_buffer;
                z.avail_out = bufsize;
 
-               if(z.avail_in == 0)
-               {
-                       //z.next_in = (char*)&data[input_i];
-                       z.next_in = (Bytef*)&data[input_i];
-                       z.avail_in = data.getSize() - input_i;
-                       input_i += z.avail_in;
-                       if(input_i == (int)data.getSize())
-                               flush = Z_FINISH;
-               }
-               if(z.avail_in == 0)
-                       break;
-               status = deflate(&z, flush);
+               status = deflate(&z, Z_FINISH);
                if(status == Z_NEED_DICT || status == Z_DATA_ERROR
                                || status == Z_MEM_ERROR)
                {
@@ -99,19 +87,20 @@ void compressZlib(SharedBuffer<u8> data, std::ostream &os)
                int count = bufsize - z.avail_out;
                if(count)
                        os.write(output_buffer, count);
+               // This determines zlib has given all output
+               if(status == Z_STREAM_END)
+                       break;
        }
 
        deflateEnd(&z);
-
 }
 
-void compressZlib(const std::string &data, std::ostream &os)
+void compressZlib(const std::string &data, std::ostream &os, int level)
 {
-       SharedBuffer<u8> databuf((u8*)data.c_str(), data.size());
-       compressZlib(databuf, os);
+       compressZlib((u8*)data.c_str(), data.size(), os, level);
 }
 
-void decompressZlib(std::istream &is, std::ostream &os)
+void decompressZlib(std::istream &is, std::ostream &os, size_t limit)
 {
        z_stream z;
        const s32 bufsize = 16384;
@@ -119,7 +108,7 @@ void decompressZlib(std::istream &is, std::ostream &os)
        char output_buffer[bufsize];
        int status = 0;
        int ret;
-       int bytes_read = 0;
+       int bytes_written = 0;
        int input_buffer_len = 0;
 
        z.zalloc = Z_NULL;
@@ -129,34 +118,39 @@ void decompressZlib(std::istream &is, std::ostream &os)
        ret = inflateInit(&z);
        if(ret != Z_OK)
                throw SerializationError("dcompressZlib: inflateInit failed");
-       
+
        z.avail_in = 0;
-       
-       //dstream<<"initial fail="<<is.fail()<<" bad="<<is.bad()<<std::endl;
 
        for(;;)
        {
+               int output_size = bufsize;
                z.next_out = (Bytef*)output_buffer;
-               z.avail_out = bufsize;
+               z.avail_out = output_size;
+
+               if (limit) {
+                       int limit_remaining = limit - bytes_written;
+                       if (limit_remaining <= 0) {
+                               // we're aborting ahead of time - throw an error?
+                               break;
+                       }
+                       if (limit_remaining < output_size) {
+                               z.avail_out = output_size = limit_remaining;
+                       }
+               }
 
                if(z.avail_in == 0)
                {
                        z.next_in = (Bytef*)input_buffer;
-                       input_buffer_len = is.readsome(input_buffer, bufsize);
+                       is.read(input_buffer, bufsize);
+                       input_buffer_len = is.gcount();
                        z.avail_in = input_buffer_len;
-                       //dstream<<"read fail="<<is.fail()<<" bad="<<is.bad()<<std::endl;
                }
                if(z.avail_in == 0)
                {
-                       //dstream<<"z.avail_in == 0"<<std::endl;
                        break;
                }
-                       
-               //dstream<<"1 z.avail_in="<<z.avail_in<<std::endl;
+
                status = inflate(&z, Z_NO_FLUSH);
-               //dstream<<"2 z.avail_in="<<z.avail_in<<std::endl;
-               bytes_read += is.gcount() - z.avail_in;
-               //dstream<<"bytes_read="<<bytes_read<<std::endl;
 
                if(status == Z_NEED_DICT || status == Z_DATA_ERROR
                                || status == Z_MEM_ERROR)
@@ -164,17 +158,14 @@ void decompressZlib(std::istream &is, std::ostream &os)
                        zerr(status);
                        throw SerializationError("decompressZlib: inflate failed");
                }
-               int count = bufsize - z.avail_out;
-               //dstream<<"count="<<count<<std::endl;
+               int count = output_size - z.avail_out;
                if(count)
                        os.write(output_buffer, count);
+               bytes_written += count;
                if(status == Z_STREAM_END)
                {
-                       //dstream<<"Z_STREAM_END"<<std::endl;
-                       
-                       //dstream<<"z.avail_in="<<z.avail_in<<std::endl;
-                       //dstream<<"fail="<<is.fail()<<" bad="<<is.bad()<<std::endl;
                        // Unget all the data that inflate didn't take
+                       is.clear(); // Just in case EOF is set
                        for(u32 i=0; i < z.avail_in; i++)
                        {
                                is.unget();
@@ -185,7 +176,7 @@ void decompressZlib(std::istream &is, std::ostream &os)
                                        throw SerializationError("decompressZlib: unget failed");
                                }
                        }
-                       
+
                        break;
                }
        }
@@ -193,27 +184,134 @@ void decompressZlib(std::istream &is, std::ostream &os)
        inflateEnd(&z);
 }
 
-void compress(SharedBuffer<u8> data, std::ostream &os, u8 version)
+struct ZSTD_Deleter {
+       void operator() (ZSTD_CStream* cstream) {
+               ZSTD_freeCStream(cstream);
+       }
+
+       void operator() (ZSTD_DStream* dstream) {
+               ZSTD_freeDStream(dstream);
+       }
+};
+
+void compressZstd(const u8 *data, size_t data_size, std::ostream &os, int level)
 {
+       // reusing the context is recommended for performance
+       // it will be destroyed when the thread ends
+       thread_local std::unique_ptr<ZSTD_CStream, ZSTD_Deleter> stream(ZSTD_createCStream());
+
+
+       ZSTD_initCStream(stream.get(), level);
+
+       const size_t bufsize = 16384;
+       char output_buffer[bufsize];
+
+       ZSTD_inBuffer input = { data, data_size, 0 };
+       ZSTD_outBuffer output = { output_buffer, bufsize, 0 };
+
+       while (input.pos < input.size) {
+               size_t ret = ZSTD_compressStream(stream.get(), &output, &input);
+               if (ZSTD_isError(ret)) {
+                       dstream << ZSTD_getErrorName(ret) << std::endl;
+                       throw SerializationError("compressZstd: failed");
+               }
+               if (output.pos) {
+                       os.write(output_buffer, output.pos);
+                       output.pos = 0;
+               }
+       }
+
+       size_t ret;
+       do {
+               ret = ZSTD_endStream(stream.get(), &output);
+               if (ZSTD_isError(ret)) {
+                       dstream << ZSTD_getErrorName(ret) << std::endl;
+                       throw SerializationError("compressZstd: failed");
+               }
+               if (output.pos) {
+                       os.write(output_buffer, output.pos);
+                       output.pos = 0;
+               }
+       } while (ret != 0);
+
+}
+
+void compressZstd(const std::string &data, std::ostream &os, int level)
+{
+       compressZstd((u8*)data.c_str(), data.size(), os, level);
+}
+
+void decompressZstd(std::istream &is, std::ostream &os)
+{
+       // reusing the context is recommended for performance
+       // it will be destroyed when the thread ends
+       thread_local std::unique_ptr<ZSTD_DStream, ZSTD_Deleter> stream(ZSTD_createDStream());
+
+       ZSTD_initDStream(stream.get());
+
+       const size_t bufsize = 16384;
+       char output_buffer[bufsize];
+       char input_buffer[bufsize];
+
+       ZSTD_outBuffer output = { output_buffer, bufsize, 0 };
+       ZSTD_inBuffer input = { input_buffer, 0, 0 };
+       size_t ret;
+       do
+       {
+               if (input.size == input.pos) {
+                       is.read(input_buffer, bufsize);
+                       input.size = is.gcount();
+                       input.pos = 0;
+               }
+
+               ret = ZSTD_decompressStream(stream.get(), &output, &input);
+               if (ZSTD_isError(ret)) {
+                       dstream << ZSTD_getErrorName(ret) << std::endl;
+                       throw SerializationError("decompressZstd: failed");
+               }
+               if (output.pos) {
+                       os.write(output_buffer, output.pos);
+                       output.pos = 0;
+               }
+       } while (ret != 0);
+
+       // Unget all the data that ZSTD_decompressStream didn't take
+       is.clear(); // Just in case EOF is set
+       for (u32 i = 0; i < input.size - input.pos; i++) {
+               is.unget();
+               if (is.fail() || is.bad())
+                       throw SerializationError("decompressZstd: unget failed");
+       }
+}
+
+void compress(u8 *data, u32 size, std::ostream &os, u8 version, int level)
+{
+       if(version >= 29)
+       {
+               // map the zlib levels [0,9] to [1,10]. -1 becomes 0 which indicates the default (currently 3)
+               compressZstd(data, size, os, level + 1);
+               return;
+       }
+
        if(version >= 11)
        {
-               compressZlib(data, os);
+               compressZlib(data, size, os, level);
                return;
        }
 
-       if(data.getSize() == 0)
+       if(size == 0)
                return;
-       
+
        // Write length (u32)
 
        u8 tmp[4];
-       writeU32(tmp, data.getSize());
+       writeU32(tmp, size);
        os.write((char*)tmp, 4);
-       
+
        // We will be writing 8-bit pairs of more_count and byte
        u8 more_count = 0;
        u8 current_byte = data[0];
-       for(u32 i=1; i<data.getSize(); i++)
+       for(u32 i=1; i<size; i++)
        {
                if(
                        data[i] != current_byte
@@ -236,8 +334,24 @@ void compress(SharedBuffer<u8> data, std::ostream &os, u8 version)
        os.write((char*)&current_byte, 1);
 }
 
+void compress(const SharedBuffer<u8> &data, std::ostream &os, u8 version, int level)
+{
+       compress(*data, data.getSize(), os, version, level);
+}
+
+void compress(const std::string &data, std::ostream &os, u8 version, int level)
+{
+       compress((u8*)data.c_str(), data.size(), os, version, level);
+}
+
 void decompress(std::istream &is, std::ostream &os, u8 version)
 {
+       if(version >= 29)
+       {
+               decompressZstd(is, os);
+               return;
+       }
+
        if(version >= 11)
        {
                decompressZlib(is, os);
@@ -249,7 +363,7 @@ void decompress(std::istream &is, std::ostream &os, u8 version)
        u8 tmp[4];
        is.read((char*)tmp, 4);
        u32 len = readU32(tmp);
-       
+
        // We will be reading 8-bit pairs of more_count and byte
        u32 count = 0;
        for(;;)
@@ -258,7 +372,7 @@ void decompress(std::istream &is, std::ostream &os, u8 version)
                u8 byte=0;
 
                is.read((char*)&more_count, 1);
-               
+
                is.read((char*)&byte, 1);
 
                if(is.eof())