opal-up 0.0.4 → 0.0.5

data/ext/up_ext/PerMessageDeflate.h

@@ -25,49 +25,49 @@
 
 /* We always define these options no matter if ZLIB is enabled or not */
 namespace uWS {
-    /* Compressor mode is 8 lowest bits where HIGH4(windowBits), LOW4(memLevel).
-     * Decompressor mode is 8 highest bits LOW4(windowBits).
-     * If compressor or decompressor bits are 1, then they are shared.
-     * If everything is just simply 0, then everything is disabled. */
-    enum CompressOptions : uint16_t {
-        /* These are not actual compression options */
-        _COMPRESSOR_MASK = 0x00FF,
-        _DECOMPRESSOR_MASK = 0x0F00,
-        /* Disabled, shared, shared are "special" values */
-        DISABLED = 0,
-        SHARED_COMPRESSOR = 1,
-        SHARED_DECOMPRESSOR = 1 << 8,
-        /* Highest 4 bits describe decompressor */
-        DEDICATED_DECOMPRESSOR_32KB = 15 << 8,
-        DEDICATED_DECOMPRESSOR_16KB = 14 << 8,
-        DEDICATED_DECOMPRESSOR_8KB = 13 << 8,
-        DEDICATED_DECOMPRESSOR_4KB = 12 << 8,
-        DEDICATED_DECOMPRESSOR_2KB = 11 << 8,
-        DEDICATED_DECOMPRESSOR_1KB = 10 << 8,
-        DEDICATED_DECOMPRESSOR_512B = 9 << 8,
-        /* Same as 32kb */
-        DEDICATED_DECOMPRESSOR = 15 << 8,
-
-        /* Lowest 8 bit describe compressor */
-        DEDICATED_COMPRESSOR_3KB = 9 << 4 | 1,
-        DEDICATED_COMPRESSOR_4KB = 9 << 4 | 2,
-        DEDICATED_COMPRESSOR_8KB = 10 << 4 | 3,
-        DEDICATED_COMPRESSOR_16KB = 11 << 4 | 4,
-        DEDICATED_COMPRESSOR_32KB = 12 << 4 | 5,
-        DEDICATED_COMPRESSOR_64KB = 13 << 4 | 6,
-        DEDICATED_COMPRESSOR_128KB = 14 << 4 | 7,
-        DEDICATED_COMPRESSOR_256KB = 15 << 4 | 8,
-        /* Same as 256kb */
-        DEDICATED_COMPRESSOR = 15 << 4 | 8
-    };
-}
+/* Compressor mode is 8 lowest bits where HIGH4(windowBits), LOW4(memLevel).
+ * Decompressor mode is 8 highest bits LOW4(windowBits).
+ * If compressor or decompressor bits are 1, then they are shared.
+ * If everything is just simply 0, then everything is disabled. */
+enum CompressOptions : uint16_t {
+  /* These are not actual compression options */
+  _COMPRESSOR_MASK = 0x00FF,
+  _DECOMPRESSOR_MASK = 0x0F00,
+  /* Disabled, shared, shared are "special" values */
+  DISABLED = 0,
+  SHARED_COMPRESSOR = 1,
+  SHARED_DECOMPRESSOR = 1 << 8,
+  /* Highest 4 bits describe decompressor */
+  DEDICATED_DECOMPRESSOR_32KB = 15 << 8,
+  DEDICATED_DECOMPRESSOR_16KB = 14 << 8,
+  DEDICATED_DECOMPRESSOR_8KB = 13 << 8,
+  DEDICATED_DECOMPRESSOR_4KB = 12 << 8,
+  DEDICATED_DECOMPRESSOR_2KB = 11 << 8,
+  DEDICATED_DECOMPRESSOR_1KB = 10 << 8,
+  DEDICATED_DECOMPRESSOR_512B = 9 << 8,
+  /* Same as 32kb */
+  DEDICATED_DECOMPRESSOR = 15 << 8,
+
+  /* Lowest 8 bit describe compressor */
+  DEDICATED_COMPRESSOR_3KB = 9 << 4 | 1,
+  DEDICATED_COMPRESSOR_4KB = 9 << 4 | 2,
+  DEDICATED_COMPRESSOR_8KB = 10 << 4 | 3,
+  DEDICATED_COMPRESSOR_16KB = 11 << 4 | 4,
+  DEDICATED_COMPRESSOR_32KB = 12 << 4 | 5,
+  DEDICATED_COMPRESSOR_64KB = 13 << 4 | 6,
+  DEDICATED_COMPRESSOR_128KB = 14 << 4 | 7,
+  DEDICATED_COMPRESSOR_256KB = 15 << 4 | 8,
+  /* Same as 256kb */
+  DEDICATED_COMPRESSOR = 15 << 4 | 8
+};
+} // namespace uWS
 
 #if !defined(UWS_NO_ZLIB) && !defined(UWS_MOCK_ZLIB)
 #include <zlib.h>
 #endif
 
-#include <string>
 #include <optional>
+#include <string>
 
 #ifdef UWS_USE_LIBDEFLATE
 #include "libdeflate.h"
@@ -80,236 +80,256 @@ namespace uWS {
 #if defined(UWS_NO_ZLIB) || defined(UWS_MOCK_ZLIB)
 struct ZlibContext {};
 struct InflationStream {
-    std::optional<std::string_view> inflate(ZlibContext * /*zlibContext*/, std::string_view compressed, size_t maxPayloadLength, bool /*reset*/) {
-        return compressed.substr(0, std::min(maxPayloadLength, compressed.length()));
-    }
-    InflationStream(CompressOptions /*compressOptions*/) {
-    }
+  std::optional<std::string_view> inflate(ZlibContext * /*zlibContext*/,
+                                          std::string_view compressed,
+                                          size_t maxPayloadLength,
+                                          bool /*reset*/) {
+    return compressed.substr(0,
+                             std::min(maxPayloadLength, compressed.length()));
+  }
+  InflationStream(CompressOptions /*compressOptions*/) {}
 };
 struct DeflationStream {
-    std::string_view deflate(ZlibContext * /*zlibContext*/, std::string_view raw, bool /*reset*/) {
-        return raw;
-    }
-    DeflationStream(CompressOptions /*compressOptions*/) {
-    }
+  std::string_view deflate(ZlibContext * /*zlibContext*/, std::string_view raw,
+                           bool /*reset*/) {
+    return raw;
+  }
+  DeflationStream(CompressOptions /*compressOptions*/) {}
 };
 #else
 
 #define LARGE_BUFFER_SIZE 1024 * 16 // todo: fix this
 
 struct ZlibContext {
-    /* Any returned data is valid until next same-class call.
-     * We need to have two classes to allow inflation followed
-     * by many deflations without modifying the inflation */
-    std::string dynamicDeflationBuffer;
-    std::string dynamicInflationBuffer;
-    char *deflationBuffer;
-    char *inflationBuffer;
+  /* Any returned data is valid until next same-class call.
+   * We need to have two classes to allow inflation followed
+   * by many deflations without modifying the inflation */
+  std::string dynamicDeflationBuffer;
+  std::string dynamicInflationBuffer;
+  char *deflationBuffer;
+  char *inflationBuffer;
 
 #ifdef UWS_USE_LIBDEFLATE
-    libdeflate_decompressor *decompressor;
-    libdeflate_compressor *compressor;
+  libdeflate_decompressor *decompressor;
+  libdeflate_compressor *compressor;
 #endif
 
-    ZlibContext() {
-        deflationBuffer = (char *) malloc(LARGE_BUFFER_SIZE);
-        inflationBuffer = (char *) malloc(LARGE_BUFFER_SIZE);
+  ZlibContext() {
+    deflationBuffer = (char *)malloc(LARGE_BUFFER_SIZE);
+    inflationBuffer = (char *)malloc(LARGE_BUFFER_SIZE);
 
 #ifdef UWS_USE_LIBDEFLATE
-        decompressor = libdeflate_alloc_decompressor();
-        compressor = libdeflate_alloc_compressor(6);
+    decompressor = libdeflate_alloc_decompressor();
+    compressor = libdeflate_alloc_compressor(6);
 #endif
-    }
+  }
 
-    ~ZlibContext() {
-        free(deflationBuffer);
-        free(inflationBuffer);
+  ~ZlibContext() {
+    free(deflationBuffer);
+    free(inflationBuffer);
 
 #ifdef UWS_USE_LIBDEFLATE
-        libdeflate_free_decompressor(decompressor);
-        libdeflate_free_compressor(compressor);
+    libdeflate_free_decompressor(decompressor);
+    libdeflate_free_compressor(compressor);
 #endif
-    }
+  }
 };
 
 struct DeflationStream {
-    z_stream deflationStream = {};
+  z_stream deflationStream = {};
 
-    DeflationStream(CompressOptions compressOptions) {
+  DeflationStream(CompressOptions compressOptions) {
 
-        /* Sliding inflator should be about 44kb by default, less than compressor */
+    /* Sliding inflator should be about 44kb by default, less than compressor */
 
-        /* Memory usage is given by 2 ^ (windowBits + 2) + 2 ^ (memLevel + 9) */
-        int windowBits = -(int) ((compressOptions & _COMPRESSOR_MASK) >> 4), memLevel = compressOptions & 0xF;
+    /* Memory usage is given by 2 ^ (windowBits + 2) + 2 ^ (memLevel + 9) */
+    int windowBits = -(int)((compressOptions & _COMPRESSOR_MASK) >> 4),
+        memLevel = compressOptions & 0xF;
 
-        //printf("windowBits: %d, memLevel: %d\n", windowBits, memLevel);
+    // printf("windowBits: %d, memLevel: %d\n", windowBits, memLevel);
 
-        deflateInit2(&deflationStream, Z_DEFAULT_COMPRESSION, Z_DEFLATED, windowBits, memLevel, Z_DEFAULT_STRATEGY);
-    }
+    deflateInit2(&deflationStream, Z_DEFAULT_COMPRESSION, Z_DEFLATED,
+                 windowBits, memLevel, Z_DEFAULT_STRATEGY);
+  }
 
-    /* Deflate and optionally reset. You must not deflate an empty string. */
-    std::string_view deflate(ZlibContext *zlibContext, std::string_view raw, bool reset) {
+  /* Deflate and optionally reset. You must not deflate an empty string. */
+  std::string_view deflate(ZlibContext *zlibContext, std::string_view raw,
+                           bool reset) {
 
 #ifdef UWS_USE_LIBDEFLATE
-        /* Run a fast path in case of shared_compressor */
-        if (reset) {
-            size_t written = 0;
-            static unsigned char buf[1024 + 1];
-
-            written = libdeflate_deflate_compress(zlibContext->compressor, raw.data(), raw.length(), buf, 1024);
-
-            if (written) {
-                memcpy(&buf[written], "\x00", 1);
-                return std::string_view((char *) buf, written + 1);
-            }
-        }
+    /* Run a fast path in case of shared_compressor */
+    if (reset) {
+      size_t written = 0;
+      static unsigned char buf[1024 + 1];
+
+      written = libdeflate_deflate_compress(zlibContext->compressor, raw.data(),
+                                            raw.length(), buf, 1024);
+
+      if (written) {
+        memcpy(&buf[written], "\x00", 1);
+        return std::string_view((char *)buf, written + 1);
+      }
+    }
 #endif
 
-        /* Odd place to clear this one, fix */
-        zlibContext->dynamicDeflationBuffer.clear();
-
-        deflationStream.next_in = (Bytef *) raw.data();
-        deflationStream.avail_in = (unsigned int) raw.length();
-
-        /* This buffer size has to be at least 6 bytes for Z_SYNC_FLUSH to work */
-        const int DEFLATE_OUTPUT_CHUNK = LARGE_BUFFER_SIZE;
+    /* Odd place to clear this one, fix */
+    zlibContext->dynamicDeflationBuffer.clear();
 
-        int err;
-        do {
-            deflationStream.next_out = (Bytef *) zlibContext->deflationBuffer;
-            deflationStream.avail_out = DEFLATE_OUTPUT_CHUNK;
+    deflationStream.next_in = (Bytef *)raw.data();
+    deflationStream.avail_in = (unsigned int)raw.length();
 
-            err = ::deflate(&deflationStream, Z_SYNC_FLUSH);
-            if (Z_OK == err && deflationStream.avail_out == 0) {
-                zlibContext->dynamicDeflationBuffer.append(zlibContext->deflationBuffer, DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out);
-                continue;
-            } else {
-                break;
-            }
-        } while (true);
+    /* This buffer size has to be at least 6 bytes for Z_SYNC_FLUSH to work */
+    const int DEFLATE_OUTPUT_CHUNK = LARGE_BUFFER_SIZE;
 
-        /* This must not change avail_out */
-        if (reset) {
-            deflateReset(&deflationStream);
-        }
+    int err;
+    do {
+      deflationStream.next_out = (Bytef *)zlibContext->deflationBuffer;
+      deflationStream.avail_out = DEFLATE_OUTPUT_CHUNK;
 
-        if (zlibContext->dynamicDeflationBuffer.length()) {
-            zlibContext->dynamicDeflationBuffer.append(zlibContext->deflationBuffer, DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out);
-
-            return std::string_view((char *) zlibContext->dynamicDeflationBuffer.data(), zlibContext->dynamicDeflationBuffer.length() - 4);
-        }
-
-        /* Note: We will get an interger overflow resulting in heap buffer overflow if Z_BUF_ERROR is returned
-         * from passing 0 as avail_in. Therefore we must not deflate an empty string */
-        return {
+      err = ::deflate(&deflationStream, Z_SYNC_FLUSH);
+      if (Z_OK == err && deflationStream.avail_out == 0) {
+        zlibContext->dynamicDeflationBuffer.append(
             zlibContext->deflationBuffer,
-            DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out - 4
-        };
+            DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out);
+        continue;
+      } else {
+        break;
+      }
+    } while (true);
+
+    /* This must not change avail_out */
+    if (reset) {
+      deflateReset(&deflationStream);
     }
 
-    ~DeflationStream() {
-        deflateEnd(&deflationStream);
+    if (zlibContext->dynamicDeflationBuffer.length()) {
+      zlibContext->dynamicDeflationBuffer.append(zlibContext->deflationBuffer,
+                                                 DEFLATE_OUTPUT_CHUNK -
+                                                     deflationStream.avail_out);
+
+      return std::string_view(
+          (char *)zlibContext->dynamicDeflationBuffer.data(),
+          zlibContext->dynamicDeflationBuffer.length() - 4);
     }
+
+    /* Note: We will get an interger overflow resulting in heap buffer overflow
+     * if Z_BUF_ERROR is returned from passing 0 as avail_in. Therefore we must
+     * not deflate an empty string */
+    return {zlibContext->deflationBuffer,
+            DEFLATE_OUTPUT_CHUNK - deflationStream.avail_out - 4};
+  }
+
+  ~DeflationStream() { deflateEnd(&deflationStream); }
 };
 
 struct InflationStream {
-    z_stream inflationStream = {};
+  z_stream inflationStream = {};
 
-    InflationStream(CompressOptions compressOptions) {
-        /* Inflation windowBits are the top 8 bits of the 16 bit compressOptions */
-        inflateInit2(&inflationStream, -(compressOptions >> 8));
-    }
+  InflationStream(CompressOptions compressOptions) {
+    /* Inflation windowBits are the top 8 bits of the 16 bit compressOptions */
+    inflateInit2(&inflationStream, -(compressOptions >> 8));
+  }
 
-    ~InflationStream() {
-        inflateEnd(&inflationStream);
-    }
+  ~InflationStream() { inflateEnd(&inflationStream); }
 
-    /* Zero length inflates are possible and valid */
-    std::optional<std::string_view> inflate(ZlibContext *zlibContext, std::string_view compressed, size_t maxPayloadLength, bool reset) {
+  /* Zero length inflates are possible and valid */
+  std::optional<std::string_view> inflate(ZlibContext *zlibContext,
+                                          std::string_view compressed,
+                                          size_t maxPayloadLength, bool reset) {
 
 #ifdef UWS_USE_LIBDEFLATE
-        /* Try fast path first */
-        size_t written = 0;
-        static char buf[1024];
-
-        /* We have to pad 9 bytes and restore those bytes when done since 9 is more than 6 of next WebSocket message */
-        char tmp[9];
-        memcpy(tmp, (char *) compressed.data() + compressed.length(), 9);
-        memcpy((char *) compressed.data() + compressed.length(), "\x00\x00\xff\xff\x01\x00\x00\xff\xff", 9);
-        libdeflate_result res = libdeflate_deflate_decompress(zlibContext->decompressor, compressed.data(), compressed.length() + 9, buf, 1024, &written);
-        memcpy((char *) compressed.data() + compressed.length(), tmp, 9);
-
-        if (res == 0) {
-            /* Fast path wins */
-            return std::string_view(buf, written);
-        }
+    /* Try fast path first */
+    size_t written = 0;
+    static char buf[1024];
+
+    /* We have to pad 9 bytes and restore those bytes when done since 9 is more
+     * than 6 of next WebSocket message */
+    char tmp[9];
+    memcpy(tmp, (char *)compressed.data() + compressed.length(), 9);
+    memcpy((char *)compressed.data() + compressed.length(),
+           "\x00\x00\xff\xff\x01\x00\x00\xff\xff", 9);
+    libdeflate_result res = libdeflate_deflate_decompress(
+        zlibContext->decompressor, compressed.data(), compressed.length() + 9,
+        buf, 1024, &written);
+    memcpy((char *)compressed.data() + compressed.length(), tmp, 9);
+
+    if (res == 0) {
+      /* Fast path wins */
+      return std::string_view(buf, written);
+    }
 #endif
 
-        /* Save off the bytes we're about to overwrite */
-        char* tailLocation = (char*)compressed.data() + compressed.length();
-        char preTailBytes[4];
-        memcpy(preTailBytes, tailLocation, 4);
-
-        /* Append tail to chunk */
-        unsigned char tail[4] = {0x00, 0x00, 0xff, 0xff};
-        memcpy(tailLocation, tail, 4);
-        compressed = {compressed.data(), compressed.length() + 4};
-
-        /* We clear this one here, could be done better */
-        zlibContext->dynamicInflationBuffer.clear();
+    /* Save off the bytes we're about to overwrite */
+    char *tailLocation = (char *)compressed.data() + compressed.length();
+    char preTailBytes[4];
+    memcpy(preTailBytes, tailLocation, 4);
 
-        inflationStream.next_in = (Bytef *) compressed.data();
-        inflationStream.avail_in = (unsigned int) compressed.length();
+    /* Append tail to chunk */
+    unsigned char tail[4] = {0x00, 0x00, 0xff, 0xff};
+    memcpy(tailLocation, tail, 4);
+    compressed = {compressed.data(), compressed.length() + 4};
 
-        int err;
-        do {
-            inflationStream.next_out = (Bytef *) zlibContext->inflationBuffer;
-            inflationStream.avail_out = LARGE_BUFFER_SIZE;
+    /* We clear this one here, could be done better */
+    zlibContext->dynamicInflationBuffer.clear();
 
-            err = ::inflate(&inflationStream, Z_SYNC_FLUSH);
-            if (err == Z_OK && inflationStream.avail_out) {
-                break;
-            }
+    inflationStream.next_in = (Bytef *)compressed.data();
+    inflationStream.avail_in = (unsigned int)compressed.length();
 
-            zlibContext->dynamicInflationBuffer.append(zlibContext->inflationBuffer, LARGE_BUFFER_SIZE - inflationStream.avail_out);
+    int err;
+    do {
+      inflationStream.next_out = (Bytef *)zlibContext->inflationBuffer;
+      inflationStream.avail_out = LARGE_BUFFER_SIZE;
 
+      err = ::inflate(&inflationStream, Z_SYNC_FLUSH);
+      if (err == Z_OK && inflationStream.avail_out) {
+        break;
+      }
 
-        } while (inflationStream.avail_out == 0 && zlibContext->dynamicInflationBuffer.length() <= maxPayloadLength);
+      zlibContext->dynamicInflationBuffer.append(zlibContext->inflationBuffer,
+                                                 LARGE_BUFFER_SIZE -
+                                                     inflationStream.avail_out);
 
-        if (reset) {
-            inflateReset(&inflationStream);
-        }
+    } while (inflationStream.avail_out == 0 &&
+             zlibContext->dynamicInflationBuffer.length() <= maxPayloadLength);
 
-        /* Restore the bytes we used for the tail */
-        memcpy(tailLocation, preTailBytes, 4);
+    if (reset) {
+      inflateReset(&inflationStream);
+    }
 
-        if ((err != Z_BUF_ERROR && err != Z_OK) || zlibContext->dynamicInflationBuffer.length() > maxPayloadLength) {
-            return std::nullopt;
-        }
+    /* Restore the bytes we used for the tail */
+    memcpy(tailLocation, preTailBytes, 4);
 
-        if (zlibContext->dynamicInflationBuffer.length()) {
-            zlibContext->dynamicInflationBuffer.append(zlibContext->inflationBuffer, LARGE_BUFFER_SIZE - inflationStream.avail_out);
+    if ((err != Z_BUF_ERROR && err != Z_OK) ||
+        zlibContext->dynamicInflationBuffer.length() > maxPayloadLength) {
+      return std::nullopt;
+    }
 
-            /* Let's be strict about the max size */
-            if (zlibContext->dynamicInflationBuffer.length() > maxPayloadLength) {
-                return std::nullopt;
-            }
+    if (zlibContext->dynamicInflationBuffer.length()) {
+      zlibContext->dynamicInflationBuffer.append(zlibContext->inflationBuffer,
+                                                 LARGE_BUFFER_SIZE -
+                                                     inflationStream.avail_out);
 
-            return std::string_view(zlibContext->dynamicInflationBuffer.data(), zlibContext->dynamicInflationBuffer.length());
-        }
+      /* Let's be strict about the max size */
+      if (zlibContext->dynamicInflationBuffer.length() > maxPayloadLength) {
+        return std::nullopt;
+      }
 
-        /* Let's be strict about the max size */
-        if ((LARGE_BUFFER_SIZE - inflationStream.avail_out) > maxPayloadLength) {
-            return std::nullopt;
-        }
+      return std::string_view(zlibContext->dynamicInflationBuffer.data(),
+                              zlibContext->dynamicInflationBuffer.length());
+    }
 
-        return std::string_view(zlibContext->inflationBuffer, LARGE_BUFFER_SIZE - inflationStream.avail_out);
+    /* Let's be strict about the max size */
+    if ((LARGE_BUFFER_SIZE - inflationStream.avail_out) > maxPayloadLength) {
+      return std::nullopt;
     }
 
+    return std::string_view(zlibContext->inflationBuffer,
+                            LARGE_BUFFER_SIZE - inflationStream.avail_out);
+  }
 };
 
 #endif
 
-}
+} // namespace uWS
 
 #endif // UWS_PERMESSAGEDEFLATE_H