blob: b0307b23ebdba17c5e748052cf754192863c5822 [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>
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +020031#include <common/hathreads.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010032#include <common/initcall.h>
33#include <common/memory.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020034
35#include <types/global.h>
36#include <types/compression.h>
37
William Lallemand727db8b2013-04-20 17:33:20 +020038#include <proto/acl.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020039#include <proto/compression.h>
William Lallemandd85f9172012-11-09 17:05:39 +010040#include <proto/freq_ctr.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
Willy Tarreaue5489742018-11-26 14:44:03 +010044#if defined(USE_ZLIB)
Willy Tarreau86abe442018-11-25 20:12:18 +010045__decl_spinlock(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)
Willy Tarreau8ceae722018-11-26 11:58:30 +0100149DECLARE_STATIC_POOL(pool_comp_ctx, "comp_ctx", sizeof(struct comp_ctx));
150
William Lallemand8b52bb32012-11-16 18:06:41 +0100151/*
152 * Alloc the comp_ctx
153 */
154static inline int init_comp_ctx(struct comp_ctx **comp_ctx)
155{
156#ifdef USE_ZLIB
157 z_stream *strm;
158
William Lallemande3a7d992012-11-20 11:25:20 +0100159 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < sizeof(struct comp_ctx))
William Lallemand8b52bb32012-11-16 18:06:41 +0100160 return -1;
161#endif
162
Willy Tarreaubafbe012017-11-24 17:34:44 +0100163 *comp_ctx = pool_alloc(pool_comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100164 if (*comp_ctx == NULL)
165 return -1;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200166#if defined(USE_SLZ)
167 (*comp_ctx)->direct_ptr = NULL;
168 (*comp_ctx)->direct_len = 0;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200169 (*comp_ctx)->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200170#elif defined(USE_ZLIB)
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200171 HA_ATOMIC_ADD(&zlib_used_memory, sizeof(struct comp_ctx));
William Lallemand8b52bb32012-11-16 18:06:41 +0100172
173 strm = &(*comp_ctx)->strm;
174 strm->zalloc = alloc_zlib;
175 strm->zfree = free_zlib;
176 strm->opaque = *comp_ctx;
177#endif
178 return 0;
179}
180
181/*
182 * Dealloc the comp_ctx
183 */
184static inline int deinit_comp_ctx(struct comp_ctx **comp_ctx)
185{
186 if (!*comp_ctx)
187 return 0;
188
Willy Tarreaubafbe012017-11-24 17:34:44 +0100189 pool_free(pool_comp_ctx, *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100190 *comp_ctx = NULL;
191
192#ifdef USE_ZLIB
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200193 HA_ATOMIC_SUB(&zlib_used_memory, sizeof(struct comp_ctx));
William Lallemand8b52bb32012-11-16 18:06:41 +0100194#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100195 return 0;
196}
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200197#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100198
William Lallemand82fe75c2012-10-23 10:25:10 +0200199
200/****************************
201 **** Identity algorithm ****
202 ****************************/
203
204/*
205 * Init the identity algorithm
206 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100207static int identity_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200208{
209 return 0;
210}
211
212/*
213 * Process data
William Lallemandbf3ae612012-11-19 12:35:37 +0100214 * Return size of consumed data or -1 on error
William Lallemand82fe75c2012-10-23 10:25:10 +0200215 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100216static 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 +0200217{
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200218 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200219 int out_len = b_room(out);
William Lallemandbf3ae612012-11-19 12:35:37 +0100220
William Lallemand82fe75c2012-10-23 10:25:10 +0200221 if (out_len < in_len)
222 return -1;
223
224 memcpy(out_data, in_data, in_len);
225
Olivier Houchardacd14032018-06-28 18:17:23 +0200226 b_add(out, in_len);
William Lallemandbf3ae612012-11-19 12:35:37 +0100227
William Lallemand82fe75c2012-10-23 10:25:10 +0200228 return in_len;
229}
230
Willy Tarreau9787efa2015-03-28 19:17:31 +0100231static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200232{
233 return 0;
234}
235
Willy Tarreau9787efa2015-03-28 19:17:31 +0100236static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out)
237{
238 return 0;
239}
240
Willy Tarreau418b8c02015-03-29 03:32:06 +0200241/*
242 * Deinit the algorithm
243 */
244static int identity_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200245{
246 return 0;
247}
248
Willy Tarreau418b8c02015-03-29 03:32:06 +0200249
250#ifdef USE_SLZ
251
252/* SLZ's gzip format (RFC1952). Returns < 0 on error. */
253static int rfc1952_init(struct comp_ctx **comp_ctx, int level)
254{
255 if (init_comp_ctx(comp_ctx) < 0)
256 return -1;
257
258 (*comp_ctx)->cur_lvl = !!level;
259 return slz_rfc1952_init(&(*comp_ctx)->strm, !!level);
260}
261
262/* SLZ's raw deflate format (RFC1951). Returns < 0 on error. */
263static int rfc1951_init(struct comp_ctx **comp_ctx, int level)
264{
265 if (init_comp_ctx(comp_ctx) < 0)
266 return -1;
267
268 (*comp_ctx)->cur_lvl = !!level;
269 return slz_rfc1951_init(&(*comp_ctx)->strm, !!level);
270}
271
272/* SLZ's zlib format (RFC1950). Returns < 0 on error. */
273static int rfc1950_init(struct comp_ctx **comp_ctx, int level)
274{
275 if (init_comp_ctx(comp_ctx) < 0)
276 return -1;
277
278 (*comp_ctx)->cur_lvl = !!level;
279 return slz_rfc1950_init(&(*comp_ctx)->strm, !!level);
280}
281
282/* Return the size of consumed data or -1. The output buffer is unused at this
283 * point, we only keep a reference to the input data or a copy of them if the
284 * reference is already used.
William Lallemand82fe75c2012-10-23 10:25:10 +0200285 */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200286static 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 +0200287{
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200288 static THREAD_LOCAL struct buffer tmpbuf = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200289
290 if (in_len <= 0)
291 return 0;
292
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200293 if (comp_ctx->direct_ptr && b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200294 /* data already being pointed to, we're in front of fragmented
295 * data and need a buffer now. We reuse the same buffer, as it's
296 * not used out of the scope of a series of add_data()*, end().
297 */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200298 if (unlikely(!tmpbuf.size)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200299 /* this is the first time we need the compression buffer */
300 if (b_alloc(&tmpbuf) == NULL)
301 return -1; /* no memory */
302 }
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200303 b_reset(&tmpbuf);
304 memcpy(b_tail(&tmpbuf), comp_ctx->direct_ptr, comp_ctx->direct_len);
305 b_add(&tmpbuf, comp_ctx->direct_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200306 comp_ctx->direct_ptr = NULL;
307 comp_ctx->direct_len = 0;
308 comp_ctx->queued = tmpbuf;
309 /* fall through buffer copy */
310 }
311
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200312 if (!b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200313 /* data already pending */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200314 memcpy(b_tail(&comp_ctx->queued), in_data, in_len);
315 b_add(&comp_ctx->queued, in_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200316 return in_len;
317 }
318
319 comp_ctx->direct_ptr = in_data;
320 comp_ctx->direct_len = in_len;
321 return in_len;
322}
323
324/* Compresses the data accumulated using add_data(), and optionally sends the
325 * format-specific trailer if <finish> is non-null. <out> is expected to have a
326 * large enough free non-wrapping space as verified by http_comp_buffer_init().
327 * The number of bytes emitted is reported.
328 */
329static int rfc195x_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int finish)
330{
331 struct slz_stream *strm = &comp_ctx->strm;
332 const char *in_ptr;
333 int in_len;
334 int out_len;
335
336 in_ptr = comp_ctx->direct_ptr;
337 in_len = comp_ctx->direct_len;
338
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200339 if (!b_is_null(&comp_ctx->queued)) {
340 in_ptr = b_head(&comp_ctx->queued);
341 in_len = b_data(&comp_ctx->queued);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200342 }
343
Olivier Houchard0b662842018-06-29 18:16:31 +0200344 out_len = b_data(out);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200345
346 if (in_ptr)
Olivier Houchardacd14032018-06-28 18:17:23 +0200347 b_add(out, slz_encode(strm, b_tail(out), in_ptr, in_len, !finish));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200348
349 if (finish)
Olivier Houchardacd14032018-06-28 18:17:23 +0200350 b_add(out, slz_finish(strm, b_tail(out)));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200351
Olivier Houchard0b662842018-06-29 18:16:31 +0200352 out_len = b_data(out) - out_len;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200353
354 /* very important, we must wipe the data we've just flushed */
355 comp_ctx->direct_len = 0;
356 comp_ctx->direct_ptr = NULL;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200357 comp_ctx->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200358
359 /* Verify compression rate limiting and CPU usage */
360 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
361 (idle_pct < compress_min_idle)) { /* idle */
362 if (comp_ctx->cur_lvl > 0)
363 strm->level = --comp_ctx->cur_lvl;
364 }
365 else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel && comp_ctx->cur_lvl < 1) {
366 strm->level = ++comp_ctx->cur_lvl;
367 }
368
369 /* and that's all */
370 return out_len;
371}
372
373static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out)
374{
375 return rfc195x_flush_or_finish(comp_ctx, out, 0);
376}
377
378static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out)
379{
380 return rfc195x_flush_or_finish(comp_ctx, out, 1);
381}
382
383/* we just need to free the comp_ctx here, nothing was allocated */
384static int rfc195x_end(struct comp_ctx **comp_ctx)
385{
386 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200387 return 0;
388}
389
Willy Tarreau418b8c02015-03-29 03:32:06 +0200390#elif defined(USE_ZLIB) /* ! USE_SLZ */
William Lallemand82fe75c2012-10-23 10:25:10 +0200391
William Lallemand2b502472012-10-30 14:30:39 +0100392/*
393 * This is a tricky allocation function using the zlib.
394 * This is based on the allocation order in deflateInit2.
395 */
396static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size)
397{
398 struct comp_ctx *ctx = opaque;
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200399 static THREAD_LOCAL char round = 0; /* order in deflateInit2 */
William Lallemand2b502472012-10-30 14:30:39 +0100400 void *buf = NULL;
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100401 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100402
William Lallemande3a7d992012-11-20 11:25:20 +0100403 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < (long)(items * size))
William Lallemand9d5f5482012-11-07 16:12:57 +0100404 goto end;
William Lallemand9d5f5482012-11-07 16:12:57 +0100405
William Lallemand2b502472012-10-30 14:30:39 +0100406 switch (round) {
407 case 0:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200408 if (zlib_pool_deflate_state == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100409 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200410 if (zlib_pool_deflate_state == NULL)
411 zlib_pool_deflate_state = create_pool("zlib_state", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100412 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200413 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100414 pool = zlib_pool_deflate_state;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100415 ctx->zlib_deflate_state = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100416 break;
417
418 case 1:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200419 if (zlib_pool_window == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100420 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200421 if (zlib_pool_window == NULL)
422 zlib_pool_window = create_pool("zlib_window", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100423 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200424 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100425 pool = zlib_pool_window;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100426 ctx->zlib_window = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100427 break;
428
429 case 2:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200430 if (zlib_pool_prev == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100431 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200432 if (zlib_pool_prev == NULL)
433 zlib_pool_prev = create_pool("zlib_prev", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100434 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200435 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100436 pool = zlib_pool_prev;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100437 ctx->zlib_prev = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100438 break;
439
440 case 3:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200441 if (zlib_pool_head == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100442 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200443 if (zlib_pool_head == NULL)
444 zlib_pool_head = create_pool("zlib_head", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100445 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200446 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100447 pool = zlib_pool_head;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100448 ctx->zlib_head = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100449 break;
450
451 case 4:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200452 if (zlib_pool_pending_buf == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100453 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200454 if (zlib_pool_pending_buf == NULL)
455 zlib_pool_pending_buf = create_pool("zlib_pending_buf", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100456 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200457 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100458 pool = zlib_pool_pending_buf;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100459 ctx->zlib_pending_buf = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100460 break;
461 }
William Lallemande3a7d992012-11-20 11:25:20 +0100462 if (buf != NULL)
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200463 HA_ATOMIC_ADD(&zlib_used_memory, pool->size);
William Lallemand9d5f5482012-11-07 16:12:57 +0100464
465end:
William Lallemand2b502472012-10-30 14:30:39 +0100466
Willy Tarreau46909852012-11-15 14:57:56 +0100467 /* deflateInit2() first allocates and checks the deflate_state, then if
468 * it succeeds, it allocates all other 4 areas at ones and checks them
469 * at the end. So we want to correctly count the rounds depending on when
470 * zlib is supposed to abort.
471 */
472 if (buf || round)
473 round = (round + 1) % 5;
William Lallemand2b502472012-10-30 14:30:39 +0100474 return buf;
475}
476
477static void free_zlib(void *opaque, void *ptr)
478{
479 struct comp_ctx *ctx = opaque;
Willy Tarreaub1fbd052012-11-10 17:49:37 +0100480 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100481
482 if (ptr == ctx->zlib_window)
William Lallemand9d5f5482012-11-07 16:12:57 +0100483 pool = zlib_pool_window;
William Lallemand2b502472012-10-30 14:30:39 +0100484 else if (ptr == ctx->zlib_deflate_state)
William Lallemand9d5f5482012-11-07 16:12:57 +0100485 pool = zlib_pool_deflate_state;
William Lallemand2b502472012-10-30 14:30:39 +0100486 else if (ptr == ctx->zlib_prev)
William Lallemand9d5f5482012-11-07 16:12:57 +0100487 pool = zlib_pool_prev;
William Lallemand2b502472012-10-30 14:30:39 +0100488 else if (ptr == ctx->zlib_head)
William Lallemand9d5f5482012-11-07 16:12:57 +0100489 pool = zlib_pool_head;
William Lallemand2b502472012-10-30 14:30:39 +0100490 else if (ptr == ctx->zlib_pending_buf)
William Lallemand9d5f5482012-11-07 16:12:57 +0100491 pool = zlib_pool_pending_buf;
William Lallemand2b502472012-10-30 14:30:39 +0100492
Willy Tarreaubafbe012017-11-24 17:34:44 +0100493 pool_free(pool, ptr);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200494 HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
William Lallemand2b502472012-10-30 14:30:39 +0100495}
496
William Lallemand82fe75c2012-10-23 10:25:10 +0200497/**************************
498**** gzip algorithm ****
499***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100500static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200501{
William Lallemand8b52bb32012-11-16 18:06:41 +0100502 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200503
William Lallemand8b52bb32012-11-16 18:06:41 +0100504 if (init_comp_ctx(comp_ctx) < 0)
505 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100506
William Lallemand8b52bb32012-11-16 18:06:41 +0100507 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200508
Willy Tarreau36878032016-12-22 19:46:17 +0100509 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 +0100510 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200511 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100512 }
513
514 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200515
516 return 0;
517}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100518
519/* Raw deflate algorithm */
520static int raw_def_init(struct comp_ctx **comp_ctx, int level)
521{
522 z_stream *strm;
523
524 if (init_comp_ctx(comp_ctx) < 0)
525 return -1;
526
527 strm = &(*comp_ctx)->strm;
528
Willy Tarreau36878032016-12-22 19:46:17 +0100529 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100530 deinit_comp_ctx(comp_ctx);
531 return -1;
532 }
533
534 (*comp_ctx)->cur_lvl = level;
535 return 0;
536}
537
William Lallemand82fe75c2012-10-23 10:25:10 +0200538/**************************
539**** Deflate algorithm ****
540***************************/
541
Willy Tarreau9f640a12015-03-28 15:46:00 +0100542static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200543{
William Lallemand8b52bb32012-11-16 18:06:41 +0100544 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200545
William Lallemand8b52bb32012-11-16 18:06:41 +0100546 if (init_comp_ctx(comp_ctx) < 0)
547 return -1;
548
549 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200550
Willy Tarreau36878032016-12-22 19:46:17 +0100551 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100552 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200553 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100554 }
555
556 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200557
558 return 0;
559}
560
William Lallemandbf3ae612012-11-19 12:35:37 +0100561/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100562static 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 +0200563{
William Lallemand82fe75c2012-10-23 10:25:10 +0200564 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100565 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200566 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200567 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200568
569 if (in_len <= 0)
570 return 0;
571
572
573 if (out_len <= 0)
574 return -1;
575
William Lallemand82fe75c2012-10-23 10:25:10 +0200576 strm->next_in = (unsigned char *)in_data;
577 strm->avail_in = in_len;
578 strm->next_out = (unsigned char *)out_data;
579 strm->avail_out = out_len;
580
581 ret = deflate(strm, Z_NO_FLUSH);
582 if (ret != Z_OK)
583 return -1;
584
585 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200586 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200587
William Lallemandbf3ae612012-11-19 12:35:37 +0100588 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200589}
590
Willy Tarreau9787efa2015-03-28 19:17:31 +0100591static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200592{
593 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200594 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100595 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200596
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200597 strm->next_in = NULL;
598 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200599 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200600 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200601
602 ret = deflate(strm, flag);
603 if (ret != Z_OK && ret != Z_STREAM_END)
604 return -1;
605
Willy Tarreaueac52592018-06-15 13:59:36 +0200606 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200607 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200608
William Lallemand072a2bf2012-11-20 17:01:01 +0100609 /* compression limit */
610 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
611 (idle_pct < compress_min_idle)) { /* idle */
612 /* decrease level */
613 if (comp_ctx->cur_lvl > 0) {
614 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100615 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
616 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100617
618 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
619 /* increase level */
620 comp_ctx->cur_lvl++ ;
621 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100622 }
623
William Lallemand82fe75c2012-10-23 10:25:10 +0200624 return out_len;
625}
626
Willy Tarreau9787efa2015-03-28 19:17:31 +0100627static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
628{
629 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
630}
631
632static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
633{
634 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
635}
636
Willy Tarreau9f640a12015-03-28 15:46:00 +0100637static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200638{
William Lallemand8b52bb32012-11-16 18:06:41 +0100639 z_stream *strm = &(*comp_ctx)->strm;
640 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200641
William Lallemand8b52bb32012-11-16 18:06:41 +0100642 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200643
William Lallemand8b52bb32012-11-16 18:06:41 +0100644 deinit_comp_ctx(comp_ctx);
645
646 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200647}
648
Willy Tarreau36878032016-12-22 19:46:17 +0100649/* config parser for global "tune.zlibmemlevel" */
650static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
651 struct proxy *defpx, const char *file, int line,
652 char **err)
653{
654 if (too_many_args(1, args, err, NULL))
655 return -1;
656
657 if (*(args[1]) == 0) {
658 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
659 return -1;
660 }
661
662 global_tune_zlibmemlevel = atoi(args[1]);
663 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
664 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
665 return -1;
666 }
667 return 0;
668}
669
670
671/* config parser for global "tune.zlibwindowsize" */
672static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
673 struct proxy *defpx, const char *file, int line,
674 char **err)
675{
676 if (too_many_args(1, args, err, NULL))
677 return -1;
678
679 if (*(args[1]) == 0) {
680 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
681 return -1;
682 }
683
684 global_tune_zlibwindowsize = atoi(args[1]);
685 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
686 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
687 return -1;
688 }
689 return 0;
690}
691
William Lallemand82fe75c2012-10-23 10:25:10 +0200692#endif /* USE_ZLIB */
693
Willy Tarreau36878032016-12-22 19:46:17 +0100694
695/* config keyword parsers */
696static struct cfg_kw_list cfg_kws = {ILH, {
697#ifdef USE_ZLIB
698 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
699 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
700#endif
701 { 0, NULL, NULL }
702}};
703
Willy Tarreau0108d902018-11-25 19:14:37 +0100704INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
705
William Lallemand727db8b2013-04-20 17:33:20 +0200706__attribute__((constructor))
707static void __comp_fetch_init(void)
708{
Willy Tarreau418b8c02015-03-29 03:32:06 +0200709#ifdef USE_SLZ
710 slz_make_crc_table();
711 slz_prepare_dist_table();
712#endif
Willy Tarreaue5489742018-11-26 14:44:03 +0100713
Willy Tarreau36878032016-12-22 19:46:17 +0100714#if defined(USE_ZLIB) && defined(DEFAULT_MAXZLIBMEM)
Willy Tarreau3bfcd102018-11-26 10:24:45 +0100715 global.maxzlibmem = DEFAULT_MAXZLIBMEM * 1024U * 1024U;
Willy Tarreau36878032016-12-22 19:46:17 +0100716#endif
Willy Tarreau80713382018-11-26 10:19:54 +0100717}
718
719static void comp_register_build_opts(void)
720{
721 char *ptr = NULL;
722 int i;
723
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100724#ifdef USE_ZLIB
725 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);
William Lallemand727db8b2013-04-20 17:33:20 +0200741}
Willy Tarreau80713382018-11-26 10:19:54 +0100742
743INITCALL0(STG_REGISTER, comp_register_build_opts);