blob: 3e98402db6f25a82a48f0c38db55db6a35c263cd [file] [log] [blame]
William Lallemand82fe75c2012-10-23 10:25:10 +02001/*
2 * HTTP compression.
3 *
4 * Copyright 2012 Exceliance, David Du Colombier <dducolombier@exceliance.fr>
5 * William Lallemand <wlallemand@exceliance.fr>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <stdio.h>
Willy Tarreau34763642012-10-26 15:05:35 +020015
Willy Tarreau418b8c02015-03-29 03:32:06 +020016#if defined(USE_SLZ)
17#include <slz.h>
18#elif defined(USE_ZLIB)
Willy Tarreau34763642012-10-26 15:05:35 +020019/* Note: the crappy zlib and openssl libs both define the "free_func" type.
20 * That's a very clever idea to use such a generic name in general purpose
21 * libraries, really... The zlib one is easier to redefine than openssl's,
22 * so let's only fix this one.
23 */
24#define free_func zlib_free_func
William Lallemand82fe75c2012-10-23 10:25:10 +020025#include <zlib.h>
Willy Tarreau34763642012-10-26 15:05:35 +020026#undef free_func
William Lallemand08289f12012-10-31 11:19:18 +010027#endif /* USE_ZLIB */
William Lallemand82fe75c2012-10-23 10:25:10 +020028
Willy Tarreau36878032016-12-22 19:46:17 +010029#include <common/cfgparse.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020030#include <common/compat.h>
William Lallemand2b502472012-10-30 14:30:39 +010031#include <common/memory.h>
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +020032#include <common/hathreads.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020033
34#include <types/global.h>
35#include <types/compression.h>
36
William Lallemand727db8b2013-04-20 17:33:20 +020037#include <proto/acl.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020038#include <proto/compression.h>
William Lallemandd85f9172012-11-09 17:05:39 +010039#include <proto/freq_ctr.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020040#include <proto/proto_http.h>
Willy Tarreaue36cbcb2015-04-03 15:40:56 +020041#include <proto/stream.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020042
William Lallemand2b502472012-10-30 14:30:39 +010043
Emeric Brun11f58862017-11-07 11:57:54 +010044#if defined(USE_SLZ) || defined(USE_ZLIB)
Christopher Faulet9dcf9b62017-11-13 10:34:01 +010045__decl_hathreads(static HA_SPINLOCK_T comp_pool_lock);
Emeric Brun11f58862017-11-07 11:57:54 +010046#endif
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +020047
William Lallemand2b502472012-10-30 14:30:39 +010048#ifdef USE_ZLIB
49
William Lallemand8b52bb32012-11-16 18:06:41 +010050static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size);
51static void free_zlib(void *opaque, void *ptr);
52
William Lallemand2b502472012-10-30 14:30:39 +010053/* zlib allocation */
54static struct pool_head *zlib_pool_deflate_state = NULL;
55static struct pool_head *zlib_pool_window = NULL;
56static struct pool_head *zlib_pool_prev = NULL;
57static struct pool_head *zlib_pool_head = NULL;
58static struct pool_head *zlib_pool_pending_buf = NULL;
59
William Lallemande3a7d992012-11-20 11:25:20 +010060long zlib_used_memory = 0;
William Lallemand9d5f5482012-11-07 16:12:57 +010061
Willy Tarreau36878032016-12-22 19:46:17 +010062static int global_tune_zlibmemlevel = 8; /* zlib memlevel */
63static int global_tune_zlibwindowsize = MAX_WBITS; /* zlib window size */
64
William Lallemand2b502472012-10-30 14:30:39 +010065#endif
66
William Lallemand072a2bf2012-11-20 17:01:01 +010067unsigned int compress_min_idle = 0;
William Lallemand8b52bb32012-11-16 18:06:41 +010068
Willy Tarreau9f640a12015-03-28 15:46:00 +010069static int identity_init(struct comp_ctx **comp_ctx, int level);
70static int identity_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
Willy Tarreau9787efa2015-03-28 19:17:31 +010071static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out);
72static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010073static int identity_end(struct comp_ctx **comp_ctx);
74
Willy Tarreau418b8c02015-03-29 03:32:06 +020075#if defined(USE_SLZ)
76
77static int rfc1950_init(struct comp_ctx **comp_ctx, int level);
78static int rfc1951_init(struct comp_ctx **comp_ctx, int level);
79static int rfc1952_init(struct comp_ctx **comp_ctx, int level);
80static int rfc195x_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
81static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out);
82static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out);
83static int rfc195x_end(struct comp_ctx **comp_ctx);
84
85#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +010086
Willy Tarreau9f640a12015-03-28 15:46:00 +010087static int gzip_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreauc91840a2015-03-28 17:00:39 +010088static int raw_def_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreau9f640a12015-03-28 15:46:00 +010089static int deflate_init(struct comp_ctx **comp_ctx, int level);
90static int deflate_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
Willy Tarreau9787efa2015-03-28 19:17:31 +010091static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out);
92static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010093static int deflate_end(struct comp_ctx **comp_ctx);
Willy Tarreau7b218772015-03-28 22:08:25 +010094
Willy Tarreau9f640a12015-03-28 15:46:00 +010095#endif /* USE_ZLIB */
96
William Lallemand2b502472012-10-30 14:30:39 +010097
Cyril Bonté6162c432012-11-10 19:27:47 +010098const struct comp_algo comp_algos[] =
William Lallemand82fe75c2012-10-23 10:25:10 +020099{
Willy Tarreau7b218772015-03-28 22:08:25 +0100100 { "identity", 8, "identity", 8, identity_init, identity_add_data, identity_flush, identity_finish, identity_end },
Willy Tarreau418b8c02015-03-29 03:32:06 +0200101#if defined(USE_SLZ)
102 { "deflate", 7, "deflate", 7, rfc1950_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
103 { "raw-deflate", 11, "deflate", 7, rfc1951_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
104 { "gzip", 4, "gzip", 4, rfc1952_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
105#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +0100106 { "deflate", 7, "deflate", 7, deflate_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
107 { "raw-deflate", 11, "deflate", 7, raw_def_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
108 { "gzip", 4, "gzip", 4, gzip_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
William Lallemand82fe75c2012-10-23 10:25:10 +0200109#endif /* USE_ZLIB */
Willy Tarreau615105e2015-03-28 16:40:46 +0100110 { NULL, 0, NULL, 0, NULL , NULL, NULL, NULL, NULL }
William Lallemand82fe75c2012-10-23 10:25:10 +0200111};
112
113/*
114 * Add a content-type in the configuration
115 */
116int comp_append_type(struct comp *comp, const char *type)
117{
118 struct comp_type *comp_type;
119
Vincent Bernat02779b62016-04-03 13:48:43 +0200120 comp_type = calloc(1, sizeof(*comp_type));
William Lallemand82fe75c2012-10-23 10:25:10 +0200121 comp_type->name_len = strlen(type);
122 comp_type->name = strdup(type);
123 comp_type->next = comp->types;
124 comp->types = comp_type;
125 return 0;
126}
127
128/*
129 * Add an algorithm in the configuration
130 */
131int comp_append_algo(struct comp *comp, const char *algo)
132{
133 struct comp_algo *comp_algo;
134 int i;
135
Willy Tarreau615105e2015-03-28 16:40:46 +0100136 for (i = 0; comp_algos[i].cfg_name; i++) {
137 if (!strcmp(algo, comp_algos[i].cfg_name)) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200138 comp_algo = calloc(1, sizeof(*comp_algo));
William Lallemand82fe75c2012-10-23 10:25:10 +0200139 memmove(comp_algo, &comp_algos[i], sizeof(struct comp_algo));
140 comp_algo->next = comp->algos;
141 comp->algos = comp_algo;
142 return 0;
143 }
144 }
145 return -1;
146}
147
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200148#if defined(USE_ZLIB) || defined(USE_SLZ)
149static struct pool_head *pool_comp_ctx = NULL;
William Lallemand8b52bb32012-11-16 18:06:41 +0100150/*
151 * Alloc the comp_ctx
152 */
153static inline int init_comp_ctx(struct comp_ctx **comp_ctx)
154{
155#ifdef USE_ZLIB
156 z_stream *strm;
157
William Lallemande3a7d992012-11-20 11:25:20 +0100158 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < sizeof(struct comp_ctx))
William Lallemand8b52bb32012-11-16 18:06:41 +0100159 return -1;
160#endif
161
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200162 if (unlikely(pool_comp_ctx == NULL)) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100163 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200164 if (unlikely(pool_comp_ctx == NULL))
165 pool_comp_ctx = create_pool("comp_ctx", sizeof(struct comp_ctx), MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100166 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200167 }
William Lallemand8b52bb32012-11-16 18:06:41 +0100168
Willy Tarreaubafbe012017-11-24 17:34:44 +0100169 *comp_ctx = pool_alloc(pool_comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100170 if (*comp_ctx == NULL)
171 return -1;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200172#if defined(USE_SLZ)
173 (*comp_ctx)->direct_ptr = NULL;
174 (*comp_ctx)->direct_len = 0;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200175 (*comp_ctx)->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200176#elif defined(USE_ZLIB)
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200177 HA_ATOMIC_ADD(&zlib_used_memory, sizeof(struct comp_ctx));
William Lallemand8b52bb32012-11-16 18:06:41 +0100178
179 strm = &(*comp_ctx)->strm;
180 strm->zalloc = alloc_zlib;
181 strm->zfree = free_zlib;
182 strm->opaque = *comp_ctx;
183#endif
184 return 0;
185}
186
187/*
188 * Dealloc the comp_ctx
189 */
190static inline int deinit_comp_ctx(struct comp_ctx **comp_ctx)
191{
192 if (!*comp_ctx)
193 return 0;
194
Willy Tarreaubafbe012017-11-24 17:34:44 +0100195 pool_free(pool_comp_ctx, *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100196 *comp_ctx = NULL;
197
198#ifdef USE_ZLIB
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200199 HA_ATOMIC_SUB(&zlib_used_memory, sizeof(struct comp_ctx));
William Lallemand8b52bb32012-11-16 18:06:41 +0100200#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100201 return 0;
202}
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200203#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100204
William Lallemand82fe75c2012-10-23 10:25:10 +0200205
206/****************************
207 **** Identity algorithm ****
208 ****************************/
209
210/*
211 * Init the identity algorithm
212 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100213static int identity_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200214{
215 return 0;
216}
217
218/*
219 * Process data
William Lallemandbf3ae612012-11-19 12:35:37 +0100220 * Return size of consumed data or -1 on error
William Lallemand82fe75c2012-10-23 10:25:10 +0200221 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100222static int identity_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200223{
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200224 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200225 int out_len = b_room(out);
William Lallemandbf3ae612012-11-19 12:35:37 +0100226
William Lallemand82fe75c2012-10-23 10:25:10 +0200227 if (out_len < in_len)
228 return -1;
229
230 memcpy(out_data, in_data, in_len);
231
Olivier Houchardacd14032018-06-28 18:17:23 +0200232 b_add(out, in_len);
William Lallemandbf3ae612012-11-19 12:35:37 +0100233
William Lallemand82fe75c2012-10-23 10:25:10 +0200234 return in_len;
235}
236
Willy Tarreau9787efa2015-03-28 19:17:31 +0100237static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200238{
239 return 0;
240}
241
Willy Tarreau9787efa2015-03-28 19:17:31 +0100242static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out)
243{
244 return 0;
245}
246
Willy Tarreau418b8c02015-03-29 03:32:06 +0200247/*
248 * Deinit the algorithm
249 */
250static int identity_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200251{
252 return 0;
253}
254
Willy Tarreau418b8c02015-03-29 03:32:06 +0200255
256#ifdef USE_SLZ
257
258/* SLZ's gzip format (RFC1952). Returns < 0 on error. */
259static int rfc1952_init(struct comp_ctx **comp_ctx, int level)
260{
261 if (init_comp_ctx(comp_ctx) < 0)
262 return -1;
263
264 (*comp_ctx)->cur_lvl = !!level;
265 return slz_rfc1952_init(&(*comp_ctx)->strm, !!level);
266}
267
268/* SLZ's raw deflate format (RFC1951). Returns < 0 on error. */
269static int rfc1951_init(struct comp_ctx **comp_ctx, int level)
270{
271 if (init_comp_ctx(comp_ctx) < 0)
272 return -1;
273
274 (*comp_ctx)->cur_lvl = !!level;
275 return slz_rfc1951_init(&(*comp_ctx)->strm, !!level);
276}
277
278/* SLZ's zlib format (RFC1950). Returns < 0 on error. */
279static int rfc1950_init(struct comp_ctx **comp_ctx, int level)
280{
281 if (init_comp_ctx(comp_ctx) < 0)
282 return -1;
283
284 (*comp_ctx)->cur_lvl = !!level;
285 return slz_rfc1950_init(&(*comp_ctx)->strm, !!level);
286}
287
288/* Return the size of consumed data or -1. The output buffer is unused at this
289 * point, we only keep a reference to the input data or a copy of them if the
290 * reference is already used.
William Lallemand82fe75c2012-10-23 10:25:10 +0200291 */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200292static int rfc195x_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200293{
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200294 static THREAD_LOCAL struct buffer tmpbuf = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200295
296 if (in_len <= 0)
297 return 0;
298
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200299 if (comp_ctx->direct_ptr && b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200300 /* data already being pointed to, we're in front of fragmented
301 * data and need a buffer now. We reuse the same buffer, as it's
302 * not used out of the scope of a series of add_data()*, end().
303 */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200304 if (unlikely(!tmpbuf.size)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200305 /* this is the first time we need the compression buffer */
306 if (b_alloc(&tmpbuf) == NULL)
307 return -1; /* no memory */
308 }
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200309 b_reset(&tmpbuf);
310 memcpy(b_tail(&tmpbuf), comp_ctx->direct_ptr, comp_ctx->direct_len);
311 b_add(&tmpbuf, comp_ctx->direct_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200312 comp_ctx->direct_ptr = NULL;
313 comp_ctx->direct_len = 0;
314 comp_ctx->queued = tmpbuf;
315 /* fall through buffer copy */
316 }
317
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200318 if (!b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200319 /* data already pending */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200320 memcpy(b_tail(&comp_ctx->queued), in_data, in_len);
321 b_add(&comp_ctx->queued, in_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200322 return in_len;
323 }
324
325 comp_ctx->direct_ptr = in_data;
326 comp_ctx->direct_len = in_len;
327 return in_len;
328}
329
330/* Compresses the data accumulated using add_data(), and optionally sends the
331 * format-specific trailer if <finish> is non-null. <out> is expected to have a
332 * large enough free non-wrapping space as verified by http_comp_buffer_init().
333 * The number of bytes emitted is reported.
334 */
335static int rfc195x_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int finish)
336{
337 struct slz_stream *strm = &comp_ctx->strm;
338 const char *in_ptr;
339 int in_len;
340 int out_len;
341
342 in_ptr = comp_ctx->direct_ptr;
343 in_len = comp_ctx->direct_len;
344
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200345 if (!b_is_null(&comp_ctx->queued)) {
346 in_ptr = b_head(&comp_ctx->queued);
347 in_len = b_data(&comp_ctx->queued);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200348 }
349
Olivier Houchard0b662842018-06-29 18:16:31 +0200350 out_len = b_data(out);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200351
352 if (in_ptr)
Olivier Houchardacd14032018-06-28 18:17:23 +0200353 b_add(out, slz_encode(strm, b_tail(out), in_ptr, in_len, !finish));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200354
355 if (finish)
Olivier Houchardacd14032018-06-28 18:17:23 +0200356 b_add(out, slz_finish(strm, b_tail(out)));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200357
Olivier Houchard0b662842018-06-29 18:16:31 +0200358 out_len = b_data(out) - out_len;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200359
360 /* very important, we must wipe the data we've just flushed */
361 comp_ctx->direct_len = 0;
362 comp_ctx->direct_ptr = NULL;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200363 comp_ctx->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200364
365 /* Verify compression rate limiting and CPU usage */
366 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
367 (idle_pct < compress_min_idle)) { /* idle */
368 if (comp_ctx->cur_lvl > 0)
369 strm->level = --comp_ctx->cur_lvl;
370 }
371 else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel && comp_ctx->cur_lvl < 1) {
372 strm->level = ++comp_ctx->cur_lvl;
373 }
374
375 /* and that's all */
376 return out_len;
377}
378
379static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out)
380{
381 return rfc195x_flush_or_finish(comp_ctx, out, 0);
382}
383
384static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out)
385{
386 return rfc195x_flush_or_finish(comp_ctx, out, 1);
387}
388
389/* we just need to free the comp_ctx here, nothing was allocated */
390static int rfc195x_end(struct comp_ctx **comp_ctx)
391{
392 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200393 return 0;
394}
395
Willy Tarreau418b8c02015-03-29 03:32:06 +0200396#elif defined(USE_ZLIB) /* ! USE_SLZ */
William Lallemand82fe75c2012-10-23 10:25:10 +0200397
William Lallemand2b502472012-10-30 14:30:39 +0100398/*
399 * This is a tricky allocation function using the zlib.
400 * This is based on the allocation order in deflateInit2.
401 */
402static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size)
403{
404 struct comp_ctx *ctx = opaque;
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200405 static THREAD_LOCAL char round = 0; /* order in deflateInit2 */
William Lallemand2b502472012-10-30 14:30:39 +0100406 void *buf = NULL;
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100407 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100408
William Lallemande3a7d992012-11-20 11:25:20 +0100409 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < (long)(items * size))
William Lallemand9d5f5482012-11-07 16:12:57 +0100410 goto end;
William Lallemand9d5f5482012-11-07 16:12:57 +0100411
William Lallemand2b502472012-10-30 14:30:39 +0100412 switch (round) {
413 case 0:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200414 if (zlib_pool_deflate_state == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100415 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200416 if (zlib_pool_deflate_state == NULL)
417 zlib_pool_deflate_state = create_pool("zlib_state", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100418 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200419 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100420 pool = zlib_pool_deflate_state;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100421 ctx->zlib_deflate_state = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100422 break;
423
424 case 1:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200425 if (zlib_pool_window == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100426 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200427 if (zlib_pool_window == NULL)
428 zlib_pool_window = create_pool("zlib_window", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100429 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200430 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100431 pool = zlib_pool_window;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100432 ctx->zlib_window = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100433 break;
434
435 case 2:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200436 if (zlib_pool_prev == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100437 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200438 if (zlib_pool_prev == NULL)
439 zlib_pool_prev = create_pool("zlib_prev", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100440 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200441 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100442 pool = zlib_pool_prev;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100443 ctx->zlib_prev = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100444 break;
445
446 case 3:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200447 if (zlib_pool_head == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100448 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200449 if (zlib_pool_head == NULL)
450 zlib_pool_head = create_pool("zlib_head", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100451 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200452 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100453 pool = zlib_pool_head;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100454 ctx->zlib_head = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100455 break;
456
457 case 4:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200458 if (zlib_pool_pending_buf == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100459 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200460 if (zlib_pool_pending_buf == NULL)
461 zlib_pool_pending_buf = create_pool("zlib_pending_buf", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100462 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200463 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100464 pool = zlib_pool_pending_buf;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100465 ctx->zlib_pending_buf = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100466 break;
467 }
William Lallemande3a7d992012-11-20 11:25:20 +0100468 if (buf != NULL)
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200469 HA_ATOMIC_ADD(&zlib_used_memory, pool->size);
William Lallemand9d5f5482012-11-07 16:12:57 +0100470
471end:
William Lallemand2b502472012-10-30 14:30:39 +0100472
Willy Tarreau46909852012-11-15 14:57:56 +0100473 /* deflateInit2() first allocates and checks the deflate_state, then if
474 * it succeeds, it allocates all other 4 areas at ones and checks them
475 * at the end. So we want to correctly count the rounds depending on when
476 * zlib is supposed to abort.
477 */
478 if (buf || round)
479 round = (round + 1) % 5;
William Lallemand2b502472012-10-30 14:30:39 +0100480 return buf;
481}
482
483static void free_zlib(void *opaque, void *ptr)
484{
485 struct comp_ctx *ctx = opaque;
Willy Tarreaub1fbd052012-11-10 17:49:37 +0100486 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100487
488 if (ptr == ctx->zlib_window)
William Lallemand9d5f5482012-11-07 16:12:57 +0100489 pool = zlib_pool_window;
William Lallemand2b502472012-10-30 14:30:39 +0100490 else if (ptr == ctx->zlib_deflate_state)
William Lallemand9d5f5482012-11-07 16:12:57 +0100491 pool = zlib_pool_deflate_state;
William Lallemand2b502472012-10-30 14:30:39 +0100492 else if (ptr == ctx->zlib_prev)
William Lallemand9d5f5482012-11-07 16:12:57 +0100493 pool = zlib_pool_prev;
William Lallemand2b502472012-10-30 14:30:39 +0100494 else if (ptr == ctx->zlib_head)
William Lallemand9d5f5482012-11-07 16:12:57 +0100495 pool = zlib_pool_head;
William Lallemand2b502472012-10-30 14:30:39 +0100496 else if (ptr == ctx->zlib_pending_buf)
William Lallemand9d5f5482012-11-07 16:12:57 +0100497 pool = zlib_pool_pending_buf;
William Lallemand2b502472012-10-30 14:30:39 +0100498
Willy Tarreaubafbe012017-11-24 17:34:44 +0100499 pool_free(pool, ptr);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200500 HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
William Lallemand2b502472012-10-30 14:30:39 +0100501}
502
William Lallemand82fe75c2012-10-23 10:25:10 +0200503/**************************
504**** gzip algorithm ****
505***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100506static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200507{
William Lallemand8b52bb32012-11-16 18:06:41 +0100508 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200509
William Lallemand8b52bb32012-11-16 18:06:41 +0100510 if (init_comp_ctx(comp_ctx) < 0)
511 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100512
William Lallemand8b52bb32012-11-16 18:06:41 +0100513 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200514
Willy Tarreau36878032016-12-22 19:46:17 +0100515 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize + 16, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100516 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200517 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100518 }
519
520 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200521
522 return 0;
523}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100524
525/* Raw deflate algorithm */
526static int raw_def_init(struct comp_ctx **comp_ctx, int level)
527{
528 z_stream *strm;
529
530 if (init_comp_ctx(comp_ctx) < 0)
531 return -1;
532
533 strm = &(*comp_ctx)->strm;
534
Willy Tarreau36878032016-12-22 19:46:17 +0100535 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100536 deinit_comp_ctx(comp_ctx);
537 return -1;
538 }
539
540 (*comp_ctx)->cur_lvl = level;
541 return 0;
542}
543
William Lallemand82fe75c2012-10-23 10:25:10 +0200544/**************************
545**** Deflate algorithm ****
546***************************/
547
Willy Tarreau9f640a12015-03-28 15:46:00 +0100548static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200549{
William Lallemand8b52bb32012-11-16 18:06:41 +0100550 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200551
William Lallemand8b52bb32012-11-16 18:06:41 +0100552 if (init_comp_ctx(comp_ctx) < 0)
553 return -1;
554
555 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200556
Willy Tarreau36878032016-12-22 19:46:17 +0100557 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100558 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200559 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100560 }
561
562 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200563
564 return 0;
565}
566
William Lallemandbf3ae612012-11-19 12:35:37 +0100567/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100568static int deflate_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200569{
William Lallemand82fe75c2012-10-23 10:25:10 +0200570 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100571 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200572 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200573 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200574
575 if (in_len <= 0)
576 return 0;
577
578
579 if (out_len <= 0)
580 return -1;
581
William Lallemand82fe75c2012-10-23 10:25:10 +0200582 strm->next_in = (unsigned char *)in_data;
583 strm->avail_in = in_len;
584 strm->next_out = (unsigned char *)out_data;
585 strm->avail_out = out_len;
586
587 ret = deflate(strm, Z_NO_FLUSH);
588 if (ret != Z_OK)
589 return -1;
590
591 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200592 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200593
William Lallemandbf3ae612012-11-19 12:35:37 +0100594 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200595}
596
Willy Tarreau9787efa2015-03-28 19:17:31 +0100597static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200598{
599 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200600 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100601 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200602
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200603 strm->next_in = NULL;
604 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200605 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200606 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200607
608 ret = deflate(strm, flag);
609 if (ret != Z_OK && ret != Z_STREAM_END)
610 return -1;
611
Willy Tarreaueac52592018-06-15 13:59:36 +0200612 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200613 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200614
William Lallemand072a2bf2012-11-20 17:01:01 +0100615 /* compression limit */
616 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
617 (idle_pct < compress_min_idle)) { /* idle */
618 /* decrease level */
619 if (comp_ctx->cur_lvl > 0) {
620 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100621 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
622 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100623
624 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
625 /* increase level */
626 comp_ctx->cur_lvl++ ;
627 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100628 }
629
William Lallemand82fe75c2012-10-23 10:25:10 +0200630 return out_len;
631}
632
Willy Tarreau9787efa2015-03-28 19:17:31 +0100633static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
634{
635 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
636}
637
638static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
639{
640 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
641}
642
Willy Tarreau9f640a12015-03-28 15:46:00 +0100643static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200644{
William Lallemand8b52bb32012-11-16 18:06:41 +0100645 z_stream *strm = &(*comp_ctx)->strm;
646 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200647
William Lallemand8b52bb32012-11-16 18:06:41 +0100648 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200649
William Lallemand8b52bb32012-11-16 18:06:41 +0100650 deinit_comp_ctx(comp_ctx);
651
652 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200653}
654
Willy Tarreau36878032016-12-22 19:46:17 +0100655/* config parser for global "tune.zlibmemlevel" */
656static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
657 struct proxy *defpx, const char *file, int line,
658 char **err)
659{
660 if (too_many_args(1, args, err, NULL))
661 return -1;
662
663 if (*(args[1]) == 0) {
664 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
665 return -1;
666 }
667
668 global_tune_zlibmemlevel = atoi(args[1]);
669 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
670 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
671 return -1;
672 }
673 return 0;
674}
675
676
677/* config parser for global "tune.zlibwindowsize" */
678static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
679 struct proxy *defpx, const char *file, int line,
680 char **err)
681{
682 if (too_many_args(1, args, err, NULL))
683 return -1;
684
685 if (*(args[1]) == 0) {
686 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
687 return -1;
688 }
689
690 global_tune_zlibwindowsize = atoi(args[1]);
691 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
692 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
693 return -1;
694 }
695 return 0;
696}
697
William Lallemand82fe75c2012-10-23 10:25:10 +0200698#endif /* USE_ZLIB */
699
Willy Tarreau36878032016-12-22 19:46:17 +0100700
701/* config keyword parsers */
702static struct cfg_kw_list cfg_kws = {ILH, {
703#ifdef USE_ZLIB
704 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
705 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
706#endif
707 { 0, NULL, NULL }
708}};
709
William Lallemand727db8b2013-04-20 17:33:20 +0200710__attribute__((constructor))
711static void __comp_fetch_init(void)
712{
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100713 char *ptr = NULL;
714 int i;
715
Willy Tarreau418b8c02015-03-29 03:32:06 +0200716#ifdef USE_SLZ
717 slz_make_crc_table();
718 slz_prepare_dist_table();
719#endif
Willy Tarreau36878032016-12-22 19:46:17 +0100720#if defined(USE_ZLIB) && defined(DEFAULT_MAXZLIBMEM)
721 global.tune.maxzlibmem = DEFAULT_MAXZLIBMEM * 1024U * 1024U,
722#endif
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100723#ifdef USE_ZLIB
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100724 HA_SPIN_INIT(&comp_pool_lock);
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100725 memprintf(&ptr, "Built with zlib version : " ZLIB_VERSION);
726 memprintf(&ptr, "%s\nRunning on zlib version : %s", ptr, zlibVersion());
727#elif defined(USE_SLZ)
728 memprintf(&ptr, "Built with libslz for stateless compression.");
Lukas Tribusb7323212017-01-11 14:24:35 +0000729#else
730 memprintf(&ptr, "Built without compression support (neither USE_ZLIB nor USE_SLZ are set).");
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100731#endif
732 memprintf(&ptr, "%s\nCompression algorithms supported :", ptr);
733
734 for (i = 0; comp_algos[i].cfg_name; i++)
735 memprintf(&ptr, "%s%s %s(\"%s\")", ptr, (i == 0 ? "" : ","), comp_algos[i].cfg_name, comp_algos[i].ua_name);
736
737 if (i == 0)
738 memprintf(&ptr, "%s none", ptr);
739
740 hap_register_build_opts(ptr, 1);
Willy Tarreau36878032016-12-22 19:46:17 +0100741 cfg_register_keywords(&cfg_kws);
William Lallemand727db8b2013-04-20 17:33:20 +0200742}