blob: 77da4057a99f8f5bf1c5f165acdc7b0c1331dae3 [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 Tarreau4c7e4b72020-05-27 12:58:42 +020029#include <haproxy/api.h>
Willy Tarreau2741c8c2020-06-02 11:28:02 +020030#include <haproxy/dynbuf.h>
Willy Tarreau36878032016-12-22 19:46:17 +010031#include <common/cfgparse.h>
Willy Tarreau3f567e42020-05-28 15:29:19 +020032#include <haproxy/thread.h>
Willy Tarreaud0ef4392020-06-02 09:38:52 +020033#include <haproxy/pool.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020034
35#include <types/global.h>
Willy Tarreau0a3bd392020-06-04 08:52:38 +020036#include <haproxy/compression-t.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020037
William Lallemand727db8b2013-04-20 17:33:20 +020038#include <proto/acl.h>
Willy Tarreau0a3bd392020-06-04 08:52:38 +020039#include <haproxy/compression.h>
Willy Tarreau66347942020-06-01 12:18:08 +020040#include <haproxy/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)
Olivier Houchard43da3432019-03-08 18:50:27 +0100171 _HA_ATOMIC_ADD(&zlib_used_memory, sizeof(struct comp_ctx));
172 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100173
174 strm = &(*comp_ctx)->strm;
175 strm->zalloc = alloc_zlib;
176 strm->zfree = free_zlib;
177 strm->opaque = *comp_ctx;
178#endif
179 return 0;
180}
181
182/*
183 * Dealloc the comp_ctx
184 */
185static inline int deinit_comp_ctx(struct comp_ctx **comp_ctx)
186{
187 if (!*comp_ctx)
188 return 0;
189
Willy Tarreaubafbe012017-11-24 17:34:44 +0100190 pool_free(pool_comp_ctx, *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100191 *comp_ctx = NULL;
192
193#ifdef USE_ZLIB
Olivier Houchard43da3432019-03-08 18:50:27 +0100194 _HA_ATOMIC_SUB(&zlib_used_memory, sizeof(struct comp_ctx));
195 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100196#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100197 return 0;
198}
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200199#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100200
William Lallemand82fe75c2012-10-23 10:25:10 +0200201
202/****************************
203 **** Identity algorithm ****
204 ****************************/
205
206/*
207 * Init the identity algorithm
208 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100209static int identity_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200210{
211 return 0;
212}
213
214/*
215 * Process data
William Lallemandbf3ae612012-11-19 12:35:37 +0100216 * Return size of consumed data or -1 on error
William Lallemand82fe75c2012-10-23 10:25:10 +0200217 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100218static 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 +0200219{
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200220 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200221 int out_len = b_room(out);
William Lallemandbf3ae612012-11-19 12:35:37 +0100222
William Lallemand82fe75c2012-10-23 10:25:10 +0200223 if (out_len < in_len)
224 return -1;
225
226 memcpy(out_data, in_data, in_len);
227
Olivier Houchardacd14032018-06-28 18:17:23 +0200228 b_add(out, in_len);
William Lallemandbf3ae612012-11-19 12:35:37 +0100229
William Lallemand82fe75c2012-10-23 10:25:10 +0200230 return in_len;
231}
232
Willy Tarreau9787efa2015-03-28 19:17:31 +0100233static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200234{
235 return 0;
236}
237
Willy Tarreau9787efa2015-03-28 19:17:31 +0100238static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out)
239{
240 return 0;
241}
242
Willy Tarreau418b8c02015-03-29 03:32:06 +0200243/*
244 * Deinit the algorithm
245 */
246static int identity_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200247{
248 return 0;
249}
250
Willy Tarreau418b8c02015-03-29 03:32:06 +0200251
252#ifdef USE_SLZ
253
254/* SLZ's gzip format (RFC1952). Returns < 0 on error. */
255static int rfc1952_init(struct comp_ctx **comp_ctx, int level)
256{
257 if (init_comp_ctx(comp_ctx) < 0)
258 return -1;
259
260 (*comp_ctx)->cur_lvl = !!level;
261 return slz_rfc1952_init(&(*comp_ctx)->strm, !!level);
262}
263
264/* SLZ's raw deflate format (RFC1951). Returns < 0 on error. */
265static int rfc1951_init(struct comp_ctx **comp_ctx, int level)
266{
267 if (init_comp_ctx(comp_ctx) < 0)
268 return -1;
269
270 (*comp_ctx)->cur_lvl = !!level;
271 return slz_rfc1951_init(&(*comp_ctx)->strm, !!level);
272}
273
274/* SLZ's zlib format (RFC1950). Returns < 0 on error. */
275static int rfc1950_init(struct comp_ctx **comp_ctx, int level)
276{
277 if (init_comp_ctx(comp_ctx) < 0)
278 return -1;
279
280 (*comp_ctx)->cur_lvl = !!level;
281 return slz_rfc1950_init(&(*comp_ctx)->strm, !!level);
282}
283
284/* Return the size of consumed data or -1. The output buffer is unused at this
285 * point, we only keep a reference to the input data or a copy of them if the
286 * reference is already used.
William Lallemand82fe75c2012-10-23 10:25:10 +0200287 */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200288static 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 +0200289{
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200290 static THREAD_LOCAL struct buffer tmpbuf = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200291
292 if (in_len <= 0)
293 return 0;
294
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200295 if (comp_ctx->direct_ptr && b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200296 /* data already being pointed to, we're in front of fragmented
297 * data and need a buffer now. We reuse the same buffer, as it's
298 * not used out of the scope of a series of add_data()*, end().
299 */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200300 if (unlikely(!tmpbuf.size)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200301 /* this is the first time we need the compression buffer */
302 if (b_alloc(&tmpbuf) == NULL)
303 return -1; /* no memory */
304 }
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200305 b_reset(&tmpbuf);
306 memcpy(b_tail(&tmpbuf), comp_ctx->direct_ptr, comp_ctx->direct_len);
307 b_add(&tmpbuf, comp_ctx->direct_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200308 comp_ctx->direct_ptr = NULL;
309 comp_ctx->direct_len = 0;
310 comp_ctx->queued = tmpbuf;
311 /* fall through buffer copy */
312 }
313
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200314 if (!b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200315 /* data already pending */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200316 memcpy(b_tail(&comp_ctx->queued), in_data, in_len);
317 b_add(&comp_ctx->queued, in_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200318 return in_len;
319 }
320
321 comp_ctx->direct_ptr = in_data;
322 comp_ctx->direct_len = in_len;
323 return in_len;
324}
325
326/* Compresses the data accumulated using add_data(), and optionally sends the
327 * format-specific trailer if <finish> is non-null. <out> is expected to have a
328 * large enough free non-wrapping space as verified by http_comp_buffer_init().
329 * The number of bytes emitted is reported.
330 */
331static int rfc195x_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int finish)
332{
333 struct slz_stream *strm = &comp_ctx->strm;
334 const char *in_ptr;
335 int in_len;
336 int out_len;
337
338 in_ptr = comp_ctx->direct_ptr;
339 in_len = comp_ctx->direct_len;
340
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200341 if (!b_is_null(&comp_ctx->queued)) {
342 in_ptr = b_head(&comp_ctx->queued);
343 in_len = b_data(&comp_ctx->queued);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200344 }
345
Olivier Houchard0b662842018-06-29 18:16:31 +0200346 out_len = b_data(out);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200347
348 if (in_ptr)
Olivier Houchardacd14032018-06-28 18:17:23 +0200349 b_add(out, slz_encode(strm, b_tail(out), in_ptr, in_len, !finish));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200350
351 if (finish)
Olivier Houchardacd14032018-06-28 18:17:23 +0200352 b_add(out, slz_finish(strm, b_tail(out)));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200353
Olivier Houchard0b662842018-06-29 18:16:31 +0200354 out_len = b_data(out) - out_len;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200355
356 /* very important, we must wipe the data we've just flushed */
357 comp_ctx->direct_len = 0;
358 comp_ctx->direct_ptr = NULL;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200359 comp_ctx->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200360
361 /* Verify compression rate limiting and CPU usage */
362 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
Willy Tarreau81036f22019-05-20 19:24:50 +0200363 (ti->idle_pct < compress_min_idle)) { /* idle */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200364 if (comp_ctx->cur_lvl > 0)
365 strm->level = --comp_ctx->cur_lvl;
366 }
367 else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel && comp_ctx->cur_lvl < 1) {
368 strm->level = ++comp_ctx->cur_lvl;
369 }
370
371 /* and that's all */
372 return out_len;
373}
374
375static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out)
376{
377 return rfc195x_flush_or_finish(comp_ctx, out, 0);
378}
379
380static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out)
381{
382 return rfc195x_flush_or_finish(comp_ctx, out, 1);
383}
384
385/* we just need to free the comp_ctx here, nothing was allocated */
386static int rfc195x_end(struct comp_ctx **comp_ctx)
387{
388 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200389 return 0;
390}
391
Willy Tarreau418b8c02015-03-29 03:32:06 +0200392#elif defined(USE_ZLIB) /* ! USE_SLZ */
William Lallemand82fe75c2012-10-23 10:25:10 +0200393
William Lallemand2b502472012-10-30 14:30:39 +0100394/*
395 * This is a tricky allocation function using the zlib.
396 * This is based on the allocation order in deflateInit2.
397 */
398static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size)
399{
400 struct comp_ctx *ctx = opaque;
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200401 static THREAD_LOCAL char round = 0; /* order in deflateInit2 */
William Lallemand2b502472012-10-30 14:30:39 +0100402 void *buf = NULL;
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100403 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100404
William Lallemande3a7d992012-11-20 11:25:20 +0100405 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < (long)(items * size))
William Lallemand9d5f5482012-11-07 16:12:57 +0100406 goto end;
William Lallemand9d5f5482012-11-07 16:12:57 +0100407
William Lallemand2b502472012-10-30 14:30:39 +0100408 switch (round) {
409 case 0:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200410 if (zlib_pool_deflate_state == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100411 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200412 if (zlib_pool_deflate_state == NULL)
413 zlib_pool_deflate_state = create_pool("zlib_state", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100414 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200415 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100416 pool = zlib_pool_deflate_state;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100417 ctx->zlib_deflate_state = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100418 break;
419
420 case 1:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200421 if (zlib_pool_window == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100422 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200423 if (zlib_pool_window == NULL)
424 zlib_pool_window = create_pool("zlib_window", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100425 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200426 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100427 pool = zlib_pool_window;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100428 ctx->zlib_window = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100429 break;
430
431 case 2:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200432 if (zlib_pool_prev == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100433 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200434 if (zlib_pool_prev == NULL)
435 zlib_pool_prev = create_pool("zlib_prev", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100436 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200437 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100438 pool = zlib_pool_prev;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100439 ctx->zlib_prev = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100440 break;
441
442 case 3:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200443 if (zlib_pool_head == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100444 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200445 if (zlib_pool_head == NULL)
446 zlib_pool_head = create_pool("zlib_head", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100447 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200448 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100449 pool = zlib_pool_head;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100450 ctx->zlib_head = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100451 break;
452
453 case 4:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200454 if (zlib_pool_pending_buf == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100455 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200456 if (zlib_pool_pending_buf == NULL)
457 zlib_pool_pending_buf = create_pool("zlib_pending_buf", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100458 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200459 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100460 pool = zlib_pool_pending_buf;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100461 ctx->zlib_pending_buf = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100462 break;
463 }
Olivier Houchard43da3432019-03-08 18:50:27 +0100464 if (buf != NULL) {
465 _HA_ATOMIC_ADD(&zlib_used_memory, pool->size);
466 __ha_barrier_atomic_store();
467 }
William Lallemand9d5f5482012-11-07 16:12:57 +0100468
469end:
William Lallemand2b502472012-10-30 14:30:39 +0100470
Willy Tarreau46909852012-11-15 14:57:56 +0100471 /* deflateInit2() first allocates and checks the deflate_state, then if
472 * it succeeds, it allocates all other 4 areas at ones and checks them
473 * at the end. So we want to correctly count the rounds depending on when
474 * zlib is supposed to abort.
475 */
476 if (buf || round)
477 round = (round + 1) % 5;
William Lallemand2b502472012-10-30 14:30:39 +0100478 return buf;
479}
480
481static void free_zlib(void *opaque, void *ptr)
482{
483 struct comp_ctx *ctx = opaque;
Willy Tarreaub1fbd052012-11-10 17:49:37 +0100484 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100485
486 if (ptr == ctx->zlib_window)
William Lallemand9d5f5482012-11-07 16:12:57 +0100487 pool = zlib_pool_window;
William Lallemand2b502472012-10-30 14:30:39 +0100488 else if (ptr == ctx->zlib_deflate_state)
William Lallemand9d5f5482012-11-07 16:12:57 +0100489 pool = zlib_pool_deflate_state;
William Lallemand2b502472012-10-30 14:30:39 +0100490 else if (ptr == ctx->zlib_prev)
William Lallemand9d5f5482012-11-07 16:12:57 +0100491 pool = zlib_pool_prev;
William Lallemand2b502472012-10-30 14:30:39 +0100492 else if (ptr == ctx->zlib_head)
William Lallemand9d5f5482012-11-07 16:12:57 +0100493 pool = zlib_pool_head;
William Lallemand2b502472012-10-30 14:30:39 +0100494 else if (ptr == ctx->zlib_pending_buf)
William Lallemand9d5f5482012-11-07 16:12:57 +0100495 pool = zlib_pool_pending_buf;
William Lallemand2b502472012-10-30 14:30:39 +0100496
Willy Tarreaubafbe012017-11-24 17:34:44 +0100497 pool_free(pool, ptr);
Olivier Houchard43da3432019-03-08 18:50:27 +0100498 _HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
499 __ha_barrier_atomic_store();
William Lallemand2b502472012-10-30 14:30:39 +0100500}
501
William Lallemand82fe75c2012-10-23 10:25:10 +0200502/**************************
503**** gzip algorithm ****
504***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100505static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200506{
William Lallemand8b52bb32012-11-16 18:06:41 +0100507 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200508
William Lallemand8b52bb32012-11-16 18:06:41 +0100509 if (init_comp_ctx(comp_ctx) < 0)
510 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100511
William Lallemand8b52bb32012-11-16 18:06:41 +0100512 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200513
Willy Tarreau36878032016-12-22 19:46:17 +0100514 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 +0100515 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200516 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100517 }
518
519 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200520
521 return 0;
522}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100523
524/* Raw deflate algorithm */
525static int raw_def_init(struct comp_ctx **comp_ctx, int level)
526{
527 z_stream *strm;
528
529 if (init_comp_ctx(comp_ctx) < 0)
530 return -1;
531
532 strm = &(*comp_ctx)->strm;
533
Willy Tarreau36878032016-12-22 19:46:17 +0100534 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100535 deinit_comp_ctx(comp_ctx);
536 return -1;
537 }
538
539 (*comp_ctx)->cur_lvl = level;
540 return 0;
541}
542
William Lallemand82fe75c2012-10-23 10:25:10 +0200543/**************************
544**** Deflate algorithm ****
545***************************/
546
Willy Tarreau9f640a12015-03-28 15:46:00 +0100547static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200548{
William Lallemand8b52bb32012-11-16 18:06:41 +0100549 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200550
William Lallemand8b52bb32012-11-16 18:06:41 +0100551 if (init_comp_ctx(comp_ctx) < 0)
552 return -1;
553
554 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200555
Willy Tarreau36878032016-12-22 19:46:17 +0100556 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100557 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200558 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100559 }
560
561 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200562
563 return 0;
564}
565
William Lallemandbf3ae612012-11-19 12:35:37 +0100566/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100567static 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 +0200568{
William Lallemand82fe75c2012-10-23 10:25:10 +0200569 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100570 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200571 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200572 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200573
574 if (in_len <= 0)
575 return 0;
576
577
578 if (out_len <= 0)
579 return -1;
580
William Lallemand82fe75c2012-10-23 10:25:10 +0200581 strm->next_in = (unsigned char *)in_data;
582 strm->avail_in = in_len;
583 strm->next_out = (unsigned char *)out_data;
584 strm->avail_out = out_len;
585
586 ret = deflate(strm, Z_NO_FLUSH);
587 if (ret != Z_OK)
588 return -1;
589
590 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200591 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200592
William Lallemandbf3ae612012-11-19 12:35:37 +0100593 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200594}
595
Willy Tarreau9787efa2015-03-28 19:17:31 +0100596static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200597{
598 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200599 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100600 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200601
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200602 strm->next_in = NULL;
603 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200604 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200605 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200606
607 ret = deflate(strm, flag);
608 if (ret != Z_OK && ret != Z_STREAM_END)
609 return -1;
610
Willy Tarreaueac52592018-06-15 13:59:36 +0200611 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200612 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200613
William Lallemand072a2bf2012-11-20 17:01:01 +0100614 /* compression limit */
615 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
Willy Tarreau81036f22019-05-20 19:24:50 +0200616 (ti->idle_pct < compress_min_idle)) { /* idle */
William Lallemand072a2bf2012-11-20 17:01:01 +0100617 /* decrease level */
618 if (comp_ctx->cur_lvl > 0) {
619 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100620 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
621 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100622
623 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
624 /* increase level */
625 comp_ctx->cur_lvl++ ;
626 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100627 }
628
William Lallemand82fe75c2012-10-23 10:25:10 +0200629 return out_len;
630}
631
Willy Tarreau9787efa2015-03-28 19:17:31 +0100632static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
633{
634 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
635}
636
637static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
638{
639 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
640}
641
Willy Tarreau9f640a12015-03-28 15:46:00 +0100642static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200643{
William Lallemand8b52bb32012-11-16 18:06:41 +0100644 z_stream *strm = &(*comp_ctx)->strm;
645 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200646
William Lallemand8b52bb32012-11-16 18:06:41 +0100647 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200648
William Lallemand8b52bb32012-11-16 18:06:41 +0100649 deinit_comp_ctx(comp_ctx);
650
651 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200652}
653
Willy Tarreau36878032016-12-22 19:46:17 +0100654/* config parser for global "tune.zlibmemlevel" */
655static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
656 struct proxy *defpx, const char *file, int line,
657 char **err)
658{
659 if (too_many_args(1, args, err, NULL))
660 return -1;
661
662 if (*(args[1]) == 0) {
663 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
664 return -1;
665 }
666
667 global_tune_zlibmemlevel = atoi(args[1]);
668 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
669 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
670 return -1;
671 }
672 return 0;
673}
674
675
676/* config parser for global "tune.zlibwindowsize" */
677static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
678 struct proxy *defpx, const char *file, int line,
679 char **err)
680{
681 if (too_many_args(1, args, err, NULL))
682 return -1;
683
684 if (*(args[1]) == 0) {
685 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
686 return -1;
687 }
688
689 global_tune_zlibwindowsize = atoi(args[1]);
690 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
691 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
692 return -1;
693 }
694 return 0;
695}
696
William Lallemand82fe75c2012-10-23 10:25:10 +0200697#endif /* USE_ZLIB */
698
Willy Tarreau36878032016-12-22 19:46:17 +0100699
700/* config keyword parsers */
701static struct cfg_kw_list cfg_kws = {ILH, {
702#ifdef USE_ZLIB
703 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
704 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
705#endif
706 { 0, NULL, NULL }
707}};
708
Willy Tarreau0108d902018-11-25 19:14:37 +0100709INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
710
William Lallemand727db8b2013-04-20 17:33:20 +0200711__attribute__((constructor))
712static void __comp_fetch_init(void)
713{
Willy Tarreau418b8c02015-03-29 03:32:06 +0200714#ifdef USE_SLZ
715 slz_make_crc_table();
716 slz_prepare_dist_table();
717#endif
Willy Tarreaue5489742018-11-26 14:44:03 +0100718
Willy Tarreau36878032016-12-22 19:46:17 +0100719#if defined(USE_ZLIB) && defined(DEFAULT_MAXZLIBMEM)
Willy Tarreau3bfcd102018-11-26 10:24:45 +0100720 global.maxzlibmem = DEFAULT_MAXZLIBMEM * 1024U * 1024U;
Willy Tarreau36878032016-12-22 19:46:17 +0100721#endif
Willy Tarreau80713382018-11-26 10:19:54 +0100722}
723
724static void comp_register_build_opts(void)
725{
726 char *ptr = NULL;
727 int i;
728
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100729#ifdef USE_ZLIB
730 memprintf(&ptr, "Built with zlib version : " ZLIB_VERSION);
731 memprintf(&ptr, "%s\nRunning on zlib version : %s", ptr, zlibVersion());
732#elif defined(USE_SLZ)
733 memprintf(&ptr, "Built with libslz for stateless compression.");
Lukas Tribusb7323212017-01-11 14:24:35 +0000734#else
735 memprintf(&ptr, "Built without compression support (neither USE_ZLIB nor USE_SLZ are set).");
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100736#endif
737 memprintf(&ptr, "%s\nCompression algorithms supported :", ptr);
738
739 for (i = 0; comp_algos[i].cfg_name; i++)
740 memprintf(&ptr, "%s%s %s(\"%s\")", ptr, (i == 0 ? "" : ","), comp_algos[i].cfg_name, comp_algos[i].ua_name);
741
742 if (i == 0)
743 memprintf(&ptr, "%s none", ptr);
744
745 hap_register_build_opts(ptr, 1);
William Lallemand727db8b2013-04-20 17:33:20 +0200746}
Willy Tarreau80713382018-11-26 10:19:54 +0100747
748INITCALL0(STG_REGISTER, comp_register_build_opts);