/*      $NetBSD: deflate.c,v 1.23 2017/05/17 06:33:04 knakahara Exp $ */
/*      $FreeBSD: src/sys/opencrypto/deflate.c,v 1.1.2.1 2002/11/21 23:34:23 sam Exp $  */
/* $OpenBSD: deflate.c,v 1.3 2001/08/20 02:45:22 hugh Exp $ */

/*
* Copyright (c) 2001 Jean-Jacques Bernard-Gundol ([email protected])
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*   notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. The name of the author may not be used to endorse or promote products
*   derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 THE AUTHOR 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 file contains a wrapper around the deflate algo compression
* functions using the zlib library (see net/zlib.{c,h})
*/

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: deflate.c,v 1.23 2017/05/17 06:33:04 knakahara Exp $");

#include <sys/types.h>
#include <sys/malloc.h>
#include <sys/param.h>
#include <sys/systm.h>
#include <net/zlib.h>

#include <opencrypto/cryptodev.h>
#include <opencrypto/deflate.h>

#define ZBUF 10

struct deflate_buf {
       u_int8_t *out;
       u_int32_t size;
};

int window_inflate = -1 * MAX_WBITS;
int window_deflate = -12;

/*
* This function takes a block of data and (de)compress it using the deflate
* algorithm
*/

static void *
ocf_zalloc(void *nil, u_int type, u_int size)
{
       void *ptr;

       ptr = malloc(type *size, M_CRYPTO_DATA, M_NOWAIT);
       return ptr;
}

static void
ocf_zfree(void *nil, void *ptr)
{
       free(ptr, M_CRYPTO_DATA);
}

u_int32_t
deflate_global(u_int8_t *data, u_int32_t size, int decomp, u_int8_t **out,
              int size_hint)
{
       /* decomp indicates whether we compress (0) or decompress (1) */

       z_stream zbuf;
       u_int8_t *output;
       u_int32_t count, result, tocopy;
       int error, i, j;
       struct deflate_buf buf[ZBUF];

       DPRINTF("size %u\n", size);

       memset(&zbuf, 0, sizeof(z_stream));
       zbuf.next_in = data;    /* data that is going to be processed */
       zbuf.zalloc = ocf_zalloc;
       zbuf.zfree = ocf_zfree;
       zbuf.opaque = Z_NULL;
       zbuf.avail_in = size;   /* Total length of data to be processed */

       if (!decomp) {
               buf[0].size = size;
       } else {
               /*
                * Choose a buffer with 4x the size of the input buffer
                * for the size of the output buffer in the case of
                * decompression. If it's not sufficient, it will need to be
                * updated while the decompression is going on
                */

               buf[0].size = MAX(size * 4, size_hint);
       }
       buf[0].out = malloc(buf[0].size, M_CRYPTO_DATA, M_NOWAIT);
       if (buf[0].out == NULL)
               return 0;
       i = 1;

       zbuf.next_out = buf[0].out;
       zbuf.avail_out = buf[0].size;

       error = decomp ? inflateInit2(&zbuf, window_inflate) :
           deflateInit2(&zbuf, Z_DEFAULT_COMPRESSION, Z_METHOD,
                   window_deflate, Z_MEMLEVEL, Z_DEFAULT_STRATEGY);

       if (error != Z_OK)
               goto bad2;
       for (;;) {
               error = decomp ? inflate(&zbuf, Z_SYNC_FLUSH) :
                                deflate(&zbuf, Z_FINISH);
               if (error == Z_STREAM_END) /* success */
                       break;
               /*
                * XXX compensate for two problems:
                * -Former versions of this code didn't set Z_FINISH
                *  on compression, so the compressed data are not correctly
                *  terminated and the decompressor doesn't get Z_STREAM_END.
                *  Accept such packets for interoperability.
                * -sys/net/zlib.c has a bug which makes that Z_BUF_ERROR is
                *  set after successful decompression under rare conditions.
                */
               else if (decomp && (error == Z_OK || error == Z_BUF_ERROR)
                        && zbuf.avail_in == 0 && zbuf.avail_out != 0)
                               break;
               else if (error != Z_OK)
                       goto bad;
               else if (zbuf.avail_out == 0) {
                       /* we need more output space, allocate size */
                       int nextsize = buf[i-1].size * 2;
                       if (i == ZBUF || nextsize > 1000000)
                               goto bad;
                       buf[i].out = malloc(nextsize, M_CRYPTO_DATA, M_NOWAIT);
                       if (buf[i].out == NULL)
                               goto bad;
                       zbuf.next_out = buf[i].out;
                       zbuf.avail_out = buf[i].size = nextsize;
                       i++;
               }
       }

       result = count = zbuf.total_out;

       if (i != 1) { /* copy everything into one buffer */
               output = malloc(result, M_CRYPTO_DATA, M_NOWAIT);
               if (output == NULL)
                       goto bad;
               *out = output;
               for (j = 0; j < i; j++) {
                       tocopy = MIN(count, buf[j].size);
                       /* XXX the last buf can be empty */
                       KASSERT(tocopy || j == (i - 1));
                       memcpy(output, buf[j].out, tocopy);
                       output += tocopy;
                       free(buf[j].out, M_CRYPTO_DATA);
                       count -= tocopy;
               }
               KASSERT(count == 0);
       } else {
               *out = buf[0].out;
       }
       if (decomp)
               inflateEnd(&zbuf);
       else
               deflateEnd(&zbuf);
       return result;

bad:
       if (decomp)
               inflateEnd(&zbuf);
       else
               deflateEnd(&zbuf);
bad2:
       for (j = 0; j < i; j++)
               free(buf[j].out, M_CRYPTO_DATA);
       return 0;
}

/*
* Initial version will perform a single gzip encapsulation,
* filling in the header,
* and appending the crc and uncompressed length.
*
* Later version will support multiple buffers with
* a flag indication final buffer.  The crc is maintained
* over all buffers and appended to the output along with
* the uncompressed length after the final data buffer
* has been compressed and output.
*
* Ditto for uncompress - CRC is extracted from the final packed
* and compared against CRC of uncompressed data.
*
*/

/* constant header for the gzip */
static const char gzip_header[10] = {
       0x1f, 0x8b,     /* ID1 ID2      */
       Z_DEFLATED,     /* CM           */
       0,              /* FLG          */
       0, 0, 0, 0,     /* MTIME        */
       0,              /* XFL          */
       0x03            /* OS (Unix)    */
};

/* Followed by compressed payload */
/* Followed by uint32_t CRC32 and uint32_t ISIZE */
#define GZIP_TAIL_SIZE  8

u_int32_t
gzip_global(u_int8_t *data, u_int32_t size,
       int decomp, u_int8_t **out, int size_hint)
{
       /* decomp indicates whether we compress (0) or decompress (1) */
       z_stream zbuf;
       u_int8_t *output;
       u_int32_t count, result;
       int error, i, j;
       struct deflate_buf buf[ZBUF];
       u_int32_t crc;
       u_int32_t isize = 0, icrc = 0;

       DPRINTF("decomp %d, size %u\n", decomp, size);

       memset(&zbuf, 0, sizeof(z_stream));
       zbuf.zalloc = ocf_zalloc;
       zbuf.zfree = ocf_zfree;
       zbuf.opaque = Z_NULL;

       if (!decomp) {
               /* compress */
               DPRINTF("compress malloc %u + %zu + %u = %zu\n",
                               size, sizeof(gzip_header), GZIP_TAIL_SIZE,
                               size + sizeof(gzip_header) + GZIP_TAIL_SIZE);

               buf[0].size = size;
               crc = crc32(0, data, size);
               DPRINTF("size %u, crc 0x%x\n", size, crc);
               zbuf.avail_in = size;   /* Total length of data to be processed */
               zbuf.next_in = data;    /* data that is going to be processed */
       } else {
               /* decompress */
               /* check the gzip header */
               if (size <= sizeof(gzip_header) + GZIP_TAIL_SIZE) {
                       /* Not enough data for the header & tail */
                       DPRINTF("not enough data (%u)\n", size);
                       return 0;
               }

               /* XXX this is pretty basic,
                * needs to be expanded to ignore MTIME, OS,
                * but still ensure flags are 0.
                * Q. Do we need to support the flags and
                * optional header fields? Likely.
                * XXX add flag and field support too.
                */
               if (memcmp(data, gzip_header, sizeof(gzip_header)) != 0) {
                       DPRINTF("unsupported gzip header (%02x%02x)\n",
                                       data[0], data[1]);
                       return 0;
               } else {
                       DPRINTF("%d: gzip header ok\n",__LINE__);
               }

               memcpy(&isize, &data[size-sizeof(uint32_t)], sizeof(uint32_t));
               LE32TOH(isize);
               memcpy(&icrc, &data[size-2*sizeof(uint32_t)], sizeof(uint32_t));
               LE32TOH(icrc);

               DPRINTF("isize = %u (%02x %02x %02x %02x)\n",
                               isize,
                               data[size-4],
                               data[size-3],
                               data[size-2],
                               data[size-1]);

               buf[0].size = isize;
               crc = crc32(0, NULL, 0);        /* get initial crc value */

               /* skip over the gzip header */
               zbuf.next_in = data + sizeof(gzip_header);

               /* actual payload size stripped of gzip header and tail */
               zbuf.avail_in = size - sizeof(gzip_header) - GZIP_TAIL_SIZE;
       }

       buf[0].out = malloc(buf[0].size, M_CRYPTO_DATA, M_NOWAIT);
       if (buf[0].out == NULL)
               return 0;
       zbuf.next_out = buf[0].out;
       zbuf.avail_out = buf[0].size;
       DPRINTF("zbuf avail_in %u, avail_out %u\n",
                       zbuf.avail_in, zbuf.avail_out);
       i = 1;

       error = decomp ? inflateInit2(&zbuf, window_inflate) :
           deflateInit2(&zbuf, Z_DEFAULT_COMPRESSION, Z_METHOD,
                   window_deflate, Z_MEMLEVEL, Z_DEFAULT_STRATEGY);

       if (error != Z_OK) {
               printf("deflateInit2() failed\n");
               goto bad2;
       }
       for (;;) {
               DPRINTF("pre: %s in:%u out:%u\n", decomp ? "deflate()" : "inflate()",
                               zbuf.avail_in, zbuf.avail_out);
               error = decomp ? inflate(&zbuf, Z_SYNC_FLUSH) :
                                deflate(&zbuf, Z_FINISH);
               DPRINTF("post: %s in:%u out:%u\n", decomp ? "deflate()" : "inflate()",
                               zbuf.avail_in, zbuf.avail_out);
               if (error == Z_STREAM_END) /* success */
                       break;
               /*
                * XXX compensate for a zlib problem:
                * -sys/net/zlib.c has a bug which makes that Z_BUF_ERROR is
                *  set after successful decompression under rare conditions.
                */
               else if (decomp && error == Z_BUF_ERROR
                        && zbuf.avail_in == 0 && zbuf.avail_out != 0)
                               break;
               else if (error != Z_OK)
                       goto bad;
               else if (zbuf.avail_out == 0) {
                       /* we need more output space, allocate size */
                       int nextsize = buf[i-1].size * 2;
                       if (i == ZBUF || nextsize > 1000000)
                               goto bad;
                       buf[i].out = malloc(nextsize, M_CRYPTO_DATA, M_NOWAIT);
                       if (buf[i].out == NULL)
                               goto bad;
                       zbuf.next_out = buf[i].out;
                       zbuf.avail_out = buf[i].size = nextsize;
                       i++;
               }
       }

       if (decomp) {
               count = result = zbuf.total_out;
       } else {
               /* need room for header, CRC, and ISIZE */
               result = zbuf.total_out + sizeof(gzip_header) + GZIP_TAIL_SIZE;
               count = zbuf.total_out;
       }

       DPRINTF("in %u -> out %u\n", size, result);

       *out = malloc(result, M_CRYPTO_DATA, M_NOWAIT);
       if (*out == NULL)
               goto bad;
       output = *out;
       if (decomp)
               inflateEnd(&zbuf);
       else {
               deflateEnd(&zbuf);

               /* fill in gzip header */
               memcpy(output, gzip_header, sizeof(gzip_header));
               output += sizeof(gzip_header);
       }
       for (j = 0; j < i; j++) {
               if (decomp) {
                       /* update crc for decompressed data */
                       crc = crc32(crc, buf[j].out, MIN(count, buf[j].size));
               }
               if (count > buf[j].size) {
                       memcpy(output, buf[j].out, buf[j].size);
                       output += buf[j].size;
                       free(buf[j].out, M_CRYPTO_DATA);
                       count -= buf[j].size;
               } else {
                       /* it should be the last buffer */
                       memcpy(output, buf[j].out, count);
                       output += count;
                       free(buf[j].out, M_CRYPTO_DATA);
                       count = 0;
               }
       }

       if (!decomp) {
               /* fill in CRC and ISIZE */
               HTOLE32(crc);
               memcpy(output, &crc, sizeof(uint32_t));
               HTOLE32(size);
               memcpy(output + sizeof(uint32_t), &size, sizeof(uint32_t));

               DPRINTF("size = 0x%x (%02x %02x %02x %02x)\n",
                               size,
                               output[7],
                               output[3],
                               output[5],
                               output[4]);
       } else {
               if (crc != icrc || result != isize) {
                       DPRINTF("crc/size mismatch\n");
                       free(*out, M_CRYPTO_DATA);
                       *out = NULL;
                       return 0;
               }
       }

       return result;

bad:
       if (decomp)
               inflateEnd(&zbuf);
       else
               deflateEnd(&zbuf);
bad2:
       *out = NULL;
       for (j = 0; j < i; j++)
               free(buf[j].out, M_CRYPTO_DATA);
       return 0;
}