summaryrefslogtreecommitdiffstats
path: root/src/openvpn/comp-lz4.c
blob: 4651148579b9b3ecde952669c970c5e3cd18f8b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
 *  OpenVPN -- An application to securely tunnel IP networks
 *             over a single UDP port, with support for SSL/TLS-based
 *             session authentication and key exchange,
 *             packet encryption, packet authentication, and
 *             packet compression.
 *
 *  Copyright (C) 2002-2012 OpenVPN Technologies, Inc. <sales@openvpn.net>
 *  Copyright (C) 2013      Gert Doering <gert@greenie.muc.de>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program (see the file COPYING included with this
 *  distribution); if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#elif defined(_MSC_VER)
#include "config-msvc.h"
#endif

#include "syshead.h"

#if defined(ENABLE_LZ4)

#if defined(NEED_COMPAT_LZ4)
#include "compat-lz4.h"
#else
#include "lz4.h"
#endif

#include "comp.h"
#include "error.h"

#include "memdbg.h"

/* Initial command byte to tell our peer if we compressed */
#define LZ4_COMPRESS_BYTE 0x69

static void
lz4_compress_init (struct compress_context *compctx)
{
  msg (D_INIT_MEDIUM, "LZ4 compression initializing");
  ASSERT(compctx->flags & COMP_F_SWAP);
}

static void
lz4_compress_uninit (struct compress_context *compctx)
{
}

static void
lz4_compress (struct buffer *buf, struct buffer work,
	       struct compress_context *compctx,
	       const struct frame* frame)
{
  bool compressed = false;

  if (buf->len <= 0)
    return;

  /*
   * In order to attempt compression, length must be at least COMPRESS_THRESHOLD.
   */
  if (buf->len >= COMPRESS_THRESHOLD)
    {
      const size_t ps = PAYLOAD_SIZE (frame);
      int zlen_max = ps + COMP_EXTRA_BUFFER (ps);
      int zlen;

      ASSERT (buf_init (&work, FRAME_HEADROOM (frame)));
      ASSERT (buf_safe (&work, zlen_max));

      if (buf->len > ps)
	{
	  dmsg (D_COMP_ERRORS, "LZ4 compression buffer overflow");
	  buf->len = 0;
	  return;
	}

      zlen = LZ4_compress_limitedOutput((const char *)BPTR(buf), (char *)BPTR(&work), BLEN(buf), zlen_max );

      if (zlen <= 0)
	{
	  dmsg (D_COMP_ERRORS, "LZ4 compression error");
	  buf->len = 0;
	  return;
	}

      ASSERT (buf_safe (&work, zlen));
      work.len = zlen;
      compressed = true;

      dmsg (D_COMP, "LZ4 compress %d -> %d", buf->len, work.len);
      compctx->pre_compress += buf->len;
      compctx->post_compress += work.len;
    }

  /* did compression save us anything? */
  {
    uint8_t comp_head_byte = NO_COMPRESS_BYTE_SWAP;
    if (compressed && work.len < buf->len)
      {
	*buf = work;
	comp_head_byte = LZ4_COMPRESS_BYTE;
      }

    {
      uint8_t *head = BPTR (buf);
      uint8_t *tail  = BEND (buf);
      ASSERT (buf_safe (buf, 1));
      ++buf->len;

      /* move head byte of payload to tail */
      *tail = *head;
      *head = comp_head_byte;
    }
  }
}

static void
lz4_decompress (struct buffer *buf, struct buffer work,
		 struct compress_context *compctx,
		 const struct frame* frame)
{
  size_t zlen_max = EXPANDED_SIZE (frame);
  int uncomp_len;
  uint8_t c;		/* flag indicating whether or not our peer compressed */

  if (buf->len <= 0)
    return;

  ASSERT (buf_init (&work, FRAME_HEADROOM (frame)));

  /* do unframing/swap (assumes buf->len > 0) */
  {
    uint8_t *head = BPTR (buf);
    c = *head;
    --buf->len;
    *head = *BEND (buf);
  }

  if (c == LZ4_COMPRESS_BYTE)	/* packet was compressed */
    {
      ASSERT (buf_safe (&work, zlen_max));
      uncomp_len = LZ4_decompress_safe((const char *)BPTR(buf), (char *)BPTR(&work), (size_t)BLEN(buf), zlen_max);
      if (uncomp_len <= 0)
	{
	  dmsg (D_COMP_ERRORS, "LZ4 decompression error: %d", uncomp_len);
	  buf->len = 0;
	  return;
	}

      ASSERT (buf_safe (&work, uncomp_len));
      work.len = uncomp_len;

      dmsg (D_COMP, "LZ4 decompress %d -> %d", buf->len, work.len);
      compctx->pre_decompress += buf->len;
      compctx->post_decompress += work.len;

      *buf = work;
    }
  else if (c == NO_COMPRESS_BYTE_SWAP)	/* packet was not compressed */
    {
      ;
    }
  else
    {
      dmsg (D_COMP_ERRORS, "Bad LZ4 decompression header byte: %d", c);
      buf->len = 0;
    }
}

const struct compress_alg lz4_alg = {
  "lz4",
  lz4_compress_init,
  lz4_compress_uninit,
  lz4_compress,
  lz4_decompress
};

#else
static void dummy(void) {}
#endif /* ENABLE_LZ4 */