blob: c9c0a308b597e826d211ff4a18c88e09e35fe04c [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 Tarreau12840be2021-04-22 14:14:22 +020016#if defined(USE_ZLIB)
Willy Tarreau34763642012-10-26 15:05:35 +020017/* Note: the crappy zlib and openssl libs both define the "free_func" type.
18 * That's a very clever idea to use such a generic name in general purpose
19 * libraries, really... The zlib one is easier to redefine than openssl's,
20 * so let's only fix this one.
21 */
22#define free_func zlib_free_func
William Lallemand82fe75c2012-10-23 10:25:10 +020023#include <zlib.h>
Willy Tarreau34763642012-10-26 15:05:35 +020024#undef free_func
William Lallemand08289f12012-10-31 11:19:18 +010025#endif /* USE_ZLIB */
William Lallemand82fe75c2012-10-23 10:25:10 +020026
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020027#include <haproxy/api.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020028#include <haproxy/cfgparse.h>
Willy Tarreau0a3bd392020-06-04 08:52:38 +020029#include <haproxy/compression-t.h>
Willy Tarreau0a3bd392020-06-04 08:52:38 +020030#include <haproxy/compression.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020031#include <haproxy/dynbuf.h>
Willy Tarreau66347942020-06-01 12:18:08 +020032#include <haproxy/freq_ctr.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/global.h>
34#include <haproxy/pool.h>
35#include <haproxy/stream.h>
36#include <haproxy/thread.h>
Willy Tarreauc624da02021-05-08 13:57:19 +020037#include <haproxy/tools.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020038
William Lallemand2b502472012-10-30 14:30:39 +010039
Willy Tarreaue5489742018-11-26 14:44:03 +010040#if defined(USE_ZLIB)
Willy Tarreau86abe442018-11-25 20:12:18 +010041__decl_spinlock(comp_pool_lock);
Emeric Brun11f58862017-11-07 11:57:54 +010042#endif
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +020043
William Lallemand2b502472012-10-30 14:30:39 +010044#ifdef USE_ZLIB
45
William Lallemand8b52bb32012-11-16 18:06:41 +010046static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size);
47static void free_zlib(void *opaque, void *ptr);
48
William Lallemand2b502472012-10-30 14:30:39 +010049/* zlib allocation */
Willy Tarreauff882702021-04-10 17:23:00 +020050static struct pool_head *zlib_pool_deflate_state __read_mostly = NULL;
51static struct pool_head *zlib_pool_window __read_mostly = NULL;
52static struct pool_head *zlib_pool_prev __read_mostly = NULL;
53static struct pool_head *zlib_pool_head __read_mostly = NULL;
54static struct pool_head *zlib_pool_pending_buf __read_mostly = NULL;
William Lallemand2b502472012-10-30 14:30:39 +010055
William Lallemande3a7d992012-11-20 11:25:20 +010056long zlib_used_memory = 0;
William Lallemand9d5f5482012-11-07 16:12:57 +010057
Willy Tarreau36878032016-12-22 19:46:17 +010058static int global_tune_zlibmemlevel = 8; /* zlib memlevel */
59static int global_tune_zlibwindowsize = MAX_WBITS; /* zlib window size */
60
William Lallemand2b502472012-10-30 14:30:39 +010061#endif
62
William Lallemand072a2bf2012-11-20 17:01:01 +010063unsigned int compress_min_idle = 0;
William Lallemand8b52bb32012-11-16 18:06:41 +010064
Willy Tarreau9f640a12015-03-28 15:46:00 +010065static int identity_init(struct comp_ctx **comp_ctx, int level);
66static 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 +010067static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out);
68static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010069static int identity_end(struct comp_ctx **comp_ctx);
70
Willy Tarreau418b8c02015-03-29 03:32:06 +020071#if defined(USE_SLZ)
72
73static int rfc1950_init(struct comp_ctx **comp_ctx, int level);
74static int rfc1951_init(struct comp_ctx **comp_ctx, int level);
75static int rfc1952_init(struct comp_ctx **comp_ctx, int level);
76static int rfc195x_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
77static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out);
78static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out);
79static int rfc195x_end(struct comp_ctx **comp_ctx);
80
81#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +010082
Willy Tarreau9f640a12015-03-28 15:46:00 +010083static int gzip_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreauc91840a2015-03-28 17:00:39 +010084static int raw_def_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreau9f640a12015-03-28 15:46:00 +010085static int deflate_init(struct comp_ctx **comp_ctx, int level);
86static 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 +010087static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out);
88static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010089static int deflate_end(struct comp_ctx **comp_ctx);
Willy Tarreau7b218772015-03-28 22:08:25 +010090
Willy Tarreau9f640a12015-03-28 15:46:00 +010091#endif /* USE_ZLIB */
92
William Lallemand2b502472012-10-30 14:30:39 +010093
Cyril Bonté6162c432012-11-10 19:27:47 +010094const struct comp_algo comp_algos[] =
William Lallemand82fe75c2012-10-23 10:25:10 +020095{
Willy Tarreau7b218772015-03-28 22:08:25 +010096 { "identity", 8, "identity", 8, identity_init, identity_add_data, identity_flush, identity_finish, identity_end },
Willy Tarreau418b8c02015-03-29 03:32:06 +020097#if defined(USE_SLZ)
98 { "deflate", 7, "deflate", 7, rfc1950_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
99 { "raw-deflate", 11, "deflate", 7, rfc1951_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
100 { "gzip", 4, "gzip", 4, rfc1952_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
101#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +0100102 { "deflate", 7, "deflate", 7, deflate_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
103 { "raw-deflate", 11, "deflate", 7, raw_def_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
104 { "gzip", 4, "gzip", 4, gzip_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
William Lallemand82fe75c2012-10-23 10:25:10 +0200105#endif /* USE_ZLIB */
Willy Tarreau615105e2015-03-28 16:40:46 +0100106 { NULL, 0, NULL, 0, NULL , NULL, NULL, NULL, NULL }
William Lallemand82fe75c2012-10-23 10:25:10 +0200107};
108
109/*
110 * Add a content-type in the configuration
111 */
112int comp_append_type(struct comp *comp, const char *type)
113{
114 struct comp_type *comp_type;
115
Vincent Bernat02779b62016-04-03 13:48:43 +0200116 comp_type = calloc(1, sizeof(*comp_type));
William Lallemand82fe75c2012-10-23 10:25:10 +0200117 comp_type->name_len = strlen(type);
118 comp_type->name = strdup(type);
119 comp_type->next = comp->types;
120 comp->types = comp_type;
121 return 0;
122}
123
124/*
125 * Add an algorithm in the configuration
126 */
127int comp_append_algo(struct comp *comp, const char *algo)
128{
129 struct comp_algo *comp_algo;
130 int i;
131
Willy Tarreau615105e2015-03-28 16:40:46 +0100132 for (i = 0; comp_algos[i].cfg_name; i++) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100133 if (strcmp(algo, comp_algos[i].cfg_name) == 0) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200134 comp_algo = calloc(1, sizeof(*comp_algo));
William Lallemand82fe75c2012-10-23 10:25:10 +0200135 memmove(comp_algo, &comp_algos[i], sizeof(struct comp_algo));
136 comp_algo->next = comp->algos;
137 comp->algos = comp_algo;
138 return 0;
139 }
140 }
141 return -1;
142}
143
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200144#if defined(USE_ZLIB) || defined(USE_SLZ)
Willy Tarreau8ceae722018-11-26 11:58:30 +0100145DECLARE_STATIC_POOL(pool_comp_ctx, "comp_ctx", sizeof(struct comp_ctx));
146
William Lallemand8b52bb32012-11-16 18:06:41 +0100147/*
148 * Alloc the comp_ctx
149 */
150static inline int init_comp_ctx(struct comp_ctx **comp_ctx)
151{
152#ifdef USE_ZLIB
153 z_stream *strm;
154
William Lallemande3a7d992012-11-20 11:25:20 +0100155 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < sizeof(struct comp_ctx))
William Lallemand8b52bb32012-11-16 18:06:41 +0100156 return -1;
157#endif
158
Willy Tarreaubafbe012017-11-24 17:34:44 +0100159 *comp_ctx = pool_alloc(pool_comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100160 if (*comp_ctx == NULL)
161 return -1;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200162#if defined(USE_SLZ)
163 (*comp_ctx)->direct_ptr = NULL;
164 (*comp_ctx)->direct_len = 0;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200165 (*comp_ctx)->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200166#elif defined(USE_ZLIB)
Olivier Houchard43da3432019-03-08 18:50:27 +0100167 _HA_ATOMIC_ADD(&zlib_used_memory, sizeof(struct comp_ctx));
168 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100169
170 strm = &(*comp_ctx)->strm;
171 strm->zalloc = alloc_zlib;
172 strm->zfree = free_zlib;
173 strm->opaque = *comp_ctx;
174#endif
175 return 0;
176}
177
178/*
179 * Dealloc the comp_ctx
180 */
181static inline int deinit_comp_ctx(struct comp_ctx **comp_ctx)
182{
183 if (!*comp_ctx)
184 return 0;
185
Willy Tarreaubafbe012017-11-24 17:34:44 +0100186 pool_free(pool_comp_ctx, *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100187 *comp_ctx = NULL;
188
189#ifdef USE_ZLIB
Olivier Houchard43da3432019-03-08 18:50:27 +0100190 _HA_ATOMIC_SUB(&zlib_used_memory, sizeof(struct comp_ctx));
191 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100192#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100193 return 0;
194}
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200195#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100196
William Lallemand82fe75c2012-10-23 10:25:10 +0200197
198/****************************
199 **** Identity algorithm ****
200 ****************************/
201
202/*
203 * Init the identity algorithm
204 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100205static int identity_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200206{
207 return 0;
208}
209
210/*
211 * Process data
William Lallemandbf3ae612012-11-19 12:35:37 +0100212 * Return size of consumed data or -1 on error
William Lallemand82fe75c2012-10-23 10:25:10 +0200213 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100214static 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 +0200215{
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200216 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200217 int out_len = b_room(out);
William Lallemandbf3ae612012-11-19 12:35:37 +0100218
William Lallemand82fe75c2012-10-23 10:25:10 +0200219 if (out_len < in_len)
220 return -1;
221
222 memcpy(out_data, in_data, in_len);
223
Olivier Houchardacd14032018-06-28 18:17:23 +0200224 b_add(out, in_len);
William Lallemandbf3ae612012-11-19 12:35:37 +0100225
William Lallemand82fe75c2012-10-23 10:25:10 +0200226 return in_len;
227}
228
Willy Tarreau9787efa2015-03-28 19:17:31 +0100229static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200230{
231 return 0;
232}
233
Willy Tarreau9787efa2015-03-28 19:17:31 +0100234static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out)
235{
236 return 0;
237}
238
Willy Tarreau418b8c02015-03-29 03:32:06 +0200239/*
240 * Deinit the algorithm
241 */
242static int identity_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200243{
244 return 0;
245}
246
Willy Tarreau418b8c02015-03-29 03:32:06 +0200247
248#ifdef USE_SLZ
249
250/* SLZ's gzip format (RFC1952). Returns < 0 on error. */
251static int rfc1952_init(struct comp_ctx **comp_ctx, int level)
252{
253 if (init_comp_ctx(comp_ctx) < 0)
254 return -1;
255
256 (*comp_ctx)->cur_lvl = !!level;
257 return slz_rfc1952_init(&(*comp_ctx)->strm, !!level);
258}
259
260/* SLZ's raw deflate format (RFC1951). Returns < 0 on error. */
261static int rfc1951_init(struct comp_ctx **comp_ctx, int level)
262{
263 if (init_comp_ctx(comp_ctx) < 0)
264 return -1;
265
266 (*comp_ctx)->cur_lvl = !!level;
267 return slz_rfc1951_init(&(*comp_ctx)->strm, !!level);
268}
269
270/* SLZ's zlib format (RFC1950). Returns < 0 on error. */
271static int rfc1950_init(struct comp_ctx **comp_ctx, int level)
272{
273 if (init_comp_ctx(comp_ctx) < 0)
274 return -1;
275
276 (*comp_ctx)->cur_lvl = !!level;
277 return slz_rfc1950_init(&(*comp_ctx)->strm, !!level);
278}
279
280/* Return the size of consumed data or -1. The output buffer is unused at this
281 * point, we only keep a reference to the input data or a copy of them if the
282 * reference is already used.
William Lallemand82fe75c2012-10-23 10:25:10 +0200283 */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200284static 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 +0200285{
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200286 static THREAD_LOCAL struct buffer tmpbuf = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200287
288 if (in_len <= 0)
289 return 0;
290
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200291 if (comp_ctx->direct_ptr && b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200292 /* data already being pointed to, we're in front of fragmented
293 * data and need a buffer now. We reuse the same buffer, as it's
294 * not used out of the scope of a series of add_data()*, end().
295 */
Willy Tarreau862ad822021-03-22 16:16:22 +0100296 if (b_alloc(&tmpbuf) == NULL)
297 return -1; /* no memory */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200298 b_reset(&tmpbuf);
299 memcpy(b_tail(&tmpbuf), comp_ctx->direct_ptr, comp_ctx->direct_len);
300 b_add(&tmpbuf, comp_ctx->direct_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200301 comp_ctx->direct_ptr = NULL;
302 comp_ctx->direct_len = 0;
303 comp_ctx->queued = tmpbuf;
304 /* fall through buffer copy */
305 }
306
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200307 if (!b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200308 /* data already pending */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200309 memcpy(b_tail(&comp_ctx->queued), in_data, in_len);
310 b_add(&comp_ctx->queued, in_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200311 return in_len;
312 }
313
314 comp_ctx->direct_ptr = in_data;
315 comp_ctx->direct_len = in_len;
316 return in_len;
317}
318
319/* Compresses the data accumulated using add_data(), and optionally sends the
320 * format-specific trailer if <finish> is non-null. <out> is expected to have a
321 * large enough free non-wrapping space as verified by http_comp_buffer_init().
322 * The number of bytes emitted is reported.
323 */
324static int rfc195x_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int finish)
325{
326 struct slz_stream *strm = &comp_ctx->strm;
327 const char *in_ptr;
328 int in_len;
329 int out_len;
330
331 in_ptr = comp_ctx->direct_ptr;
332 in_len = comp_ctx->direct_len;
333
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200334 if (!b_is_null(&comp_ctx->queued)) {
335 in_ptr = b_head(&comp_ctx->queued);
336 in_len = b_data(&comp_ctx->queued);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200337 }
338
Olivier Houchard0b662842018-06-29 18:16:31 +0200339 out_len = b_data(out);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200340
341 if (in_ptr)
Olivier Houchardacd14032018-06-28 18:17:23 +0200342 b_add(out, slz_encode(strm, b_tail(out), in_ptr, in_len, !finish));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200343
344 if (finish)
Olivier Houchardacd14032018-06-28 18:17:23 +0200345 b_add(out, slz_finish(strm, b_tail(out)));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200346
Olivier Houchard0b662842018-06-29 18:16:31 +0200347 out_len = b_data(out) - out_len;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200348
349 /* very important, we must wipe the data we've just flushed */
350 comp_ctx->direct_len = 0;
351 comp_ctx->direct_ptr = NULL;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200352 comp_ctx->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200353
354 /* Verify compression rate limiting and CPU usage */
355 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 +0200356 (ti->idle_pct < compress_min_idle)) { /* idle */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200357 if (comp_ctx->cur_lvl > 0)
358 strm->level = --comp_ctx->cur_lvl;
359 }
360 else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel && comp_ctx->cur_lvl < 1) {
361 strm->level = ++comp_ctx->cur_lvl;
362 }
363
364 /* and that's all */
365 return out_len;
366}
367
368static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out)
369{
370 return rfc195x_flush_or_finish(comp_ctx, out, 0);
371}
372
373static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out)
374{
375 return rfc195x_flush_or_finish(comp_ctx, out, 1);
376}
377
378/* we just need to free the comp_ctx here, nothing was allocated */
379static int rfc195x_end(struct comp_ctx **comp_ctx)
380{
381 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200382 return 0;
383}
384
Willy Tarreau418b8c02015-03-29 03:32:06 +0200385#elif defined(USE_ZLIB) /* ! USE_SLZ */
William Lallemand82fe75c2012-10-23 10:25:10 +0200386
William Lallemand2b502472012-10-30 14:30:39 +0100387/*
388 * This is a tricky allocation function using the zlib.
389 * This is based on the allocation order in deflateInit2.
390 */
391static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size)
392{
393 struct comp_ctx *ctx = opaque;
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200394 static THREAD_LOCAL char round = 0; /* order in deflateInit2 */
William Lallemand2b502472012-10-30 14:30:39 +0100395 void *buf = NULL;
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100396 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100397
William Lallemande3a7d992012-11-20 11:25:20 +0100398 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < (long)(items * size))
William Lallemand9d5f5482012-11-07 16:12:57 +0100399 goto end;
William Lallemand9d5f5482012-11-07 16:12:57 +0100400
William Lallemand2b502472012-10-30 14:30:39 +0100401 switch (round) {
402 case 0:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200403 if (zlib_pool_deflate_state == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100404 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200405 if (zlib_pool_deflate_state == NULL)
406 zlib_pool_deflate_state = create_pool("zlib_state", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100407 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200408 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100409 pool = zlib_pool_deflate_state;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100410 ctx->zlib_deflate_state = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100411 break;
412
413 case 1:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200414 if (zlib_pool_window == 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_window == NULL)
417 zlib_pool_window = create_pool("zlib_window", 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_window;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100421 ctx->zlib_window = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100422 break;
423
424 case 2:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200425 if (zlib_pool_prev == 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_prev == NULL)
428 zlib_pool_prev = create_pool("zlib_prev", 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_prev;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100432 ctx->zlib_prev = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100433 break;
434
435 case 3:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200436 if (zlib_pool_head == 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_head == NULL)
439 zlib_pool_head = create_pool("zlib_head", 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_head;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100443 ctx->zlib_head = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100444 break;
445
446 case 4:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200447 if (zlib_pool_pending_buf == 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_pending_buf == NULL)
450 zlib_pool_pending_buf = create_pool("zlib_pending_buf", 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_pending_buf;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100454 ctx->zlib_pending_buf = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100455 break;
456 }
Olivier Houchard43da3432019-03-08 18:50:27 +0100457 if (buf != NULL) {
458 _HA_ATOMIC_ADD(&zlib_used_memory, pool->size);
459 __ha_barrier_atomic_store();
460 }
William Lallemand9d5f5482012-11-07 16:12:57 +0100461
462end:
William Lallemand2b502472012-10-30 14:30:39 +0100463
Willy Tarreau46909852012-11-15 14:57:56 +0100464 /* deflateInit2() first allocates and checks the deflate_state, then if
465 * it succeeds, it allocates all other 4 areas at ones and checks them
466 * at the end. So we want to correctly count the rounds depending on when
467 * zlib is supposed to abort.
468 */
469 if (buf || round)
470 round = (round + 1) % 5;
William Lallemand2b502472012-10-30 14:30:39 +0100471 return buf;
472}
473
474static void free_zlib(void *opaque, void *ptr)
475{
476 struct comp_ctx *ctx = opaque;
Willy Tarreaub1fbd052012-11-10 17:49:37 +0100477 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100478
479 if (ptr == ctx->zlib_window)
William Lallemand9d5f5482012-11-07 16:12:57 +0100480 pool = zlib_pool_window;
William Lallemand2b502472012-10-30 14:30:39 +0100481 else if (ptr == ctx->zlib_deflate_state)
William Lallemand9d5f5482012-11-07 16:12:57 +0100482 pool = zlib_pool_deflate_state;
William Lallemand2b502472012-10-30 14:30:39 +0100483 else if (ptr == ctx->zlib_prev)
William Lallemand9d5f5482012-11-07 16:12:57 +0100484 pool = zlib_pool_prev;
William Lallemand2b502472012-10-30 14:30:39 +0100485 else if (ptr == ctx->zlib_head)
William Lallemand9d5f5482012-11-07 16:12:57 +0100486 pool = zlib_pool_head;
William Lallemand2b502472012-10-30 14:30:39 +0100487 else if (ptr == ctx->zlib_pending_buf)
William Lallemand9d5f5482012-11-07 16:12:57 +0100488 pool = zlib_pool_pending_buf;
Willy Tarreaud999a492020-06-14 07:50:18 +0200489 else {
490 // never matched, just to silence gcc
491 ABORT_NOW();
492 return;
493 }
William Lallemand2b502472012-10-30 14:30:39 +0100494
Willy Tarreaubafbe012017-11-24 17:34:44 +0100495 pool_free(pool, ptr);
Olivier Houchard43da3432019-03-08 18:50:27 +0100496 _HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
497 __ha_barrier_atomic_store();
William Lallemand2b502472012-10-30 14:30:39 +0100498}
499
William Lallemand82fe75c2012-10-23 10:25:10 +0200500/**************************
501**** gzip algorithm ****
502***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100503static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200504{
William Lallemand8b52bb32012-11-16 18:06:41 +0100505 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200506
William Lallemand8b52bb32012-11-16 18:06:41 +0100507 if (init_comp_ctx(comp_ctx) < 0)
508 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100509
William Lallemand8b52bb32012-11-16 18:06:41 +0100510 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200511
Willy Tarreau36878032016-12-22 19:46:17 +0100512 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 +0100513 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200514 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100515 }
516
517 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200518
519 return 0;
520}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100521
522/* Raw deflate algorithm */
523static int raw_def_init(struct comp_ctx **comp_ctx, int level)
524{
525 z_stream *strm;
526
527 if (init_comp_ctx(comp_ctx) < 0)
528 return -1;
529
530 strm = &(*comp_ctx)->strm;
531
Willy Tarreau36878032016-12-22 19:46:17 +0100532 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100533 deinit_comp_ctx(comp_ctx);
534 return -1;
535 }
536
537 (*comp_ctx)->cur_lvl = level;
538 return 0;
539}
540
William Lallemand82fe75c2012-10-23 10:25:10 +0200541/**************************
542**** Deflate algorithm ****
543***************************/
544
Willy Tarreau9f640a12015-03-28 15:46:00 +0100545static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200546{
William Lallemand8b52bb32012-11-16 18:06:41 +0100547 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200548
William Lallemand8b52bb32012-11-16 18:06:41 +0100549 if (init_comp_ctx(comp_ctx) < 0)
550 return -1;
551
552 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200553
Willy Tarreau36878032016-12-22 19:46:17 +0100554 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100555 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200556 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100557 }
558
559 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200560
561 return 0;
562}
563
William Lallemandbf3ae612012-11-19 12:35:37 +0100564/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100565static 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 +0200566{
William Lallemand82fe75c2012-10-23 10:25:10 +0200567 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100568 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200569 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200570 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200571
572 if (in_len <= 0)
573 return 0;
574
575
576 if (out_len <= 0)
577 return -1;
578
William Lallemand82fe75c2012-10-23 10:25:10 +0200579 strm->next_in = (unsigned char *)in_data;
580 strm->avail_in = in_len;
581 strm->next_out = (unsigned char *)out_data;
582 strm->avail_out = out_len;
583
584 ret = deflate(strm, Z_NO_FLUSH);
585 if (ret != Z_OK)
586 return -1;
587
588 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200589 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200590
William Lallemandbf3ae612012-11-19 12:35:37 +0100591 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200592}
593
Willy Tarreau9787efa2015-03-28 19:17:31 +0100594static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200595{
596 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200597 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100598 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200599
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200600 strm->next_in = NULL;
601 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200602 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200603 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200604
605 ret = deflate(strm, flag);
606 if (ret != Z_OK && ret != Z_STREAM_END)
607 return -1;
608
Willy Tarreaueac52592018-06-15 13:59:36 +0200609 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200610 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200611
William Lallemand072a2bf2012-11-20 17:01:01 +0100612 /* compression limit */
613 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 +0200614 (ti->idle_pct < compress_min_idle)) { /* idle */
William Lallemand072a2bf2012-11-20 17:01:01 +0100615 /* decrease level */
616 if (comp_ctx->cur_lvl > 0) {
617 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100618 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
619 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100620
621 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
622 /* increase level */
623 comp_ctx->cur_lvl++ ;
624 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100625 }
626
William Lallemand82fe75c2012-10-23 10:25:10 +0200627 return out_len;
628}
629
Willy Tarreau9787efa2015-03-28 19:17:31 +0100630static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
631{
632 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
633}
634
635static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
636{
637 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
638}
639
Willy Tarreau9f640a12015-03-28 15:46:00 +0100640static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200641{
William Lallemand8b52bb32012-11-16 18:06:41 +0100642 z_stream *strm = &(*comp_ctx)->strm;
643 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200644
William Lallemand8b52bb32012-11-16 18:06:41 +0100645 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200646
William Lallemand8b52bb32012-11-16 18:06:41 +0100647 deinit_comp_ctx(comp_ctx);
648
649 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200650}
651
Willy Tarreau36878032016-12-22 19:46:17 +0100652/* config parser for global "tune.zlibmemlevel" */
653static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
Willy Tarreau5a1c7282021-03-09 16:55:18 +0100654 const struct proxy *defpx, const char *file, int line,
Willy Tarreau36878032016-12-22 19:46:17 +0100655 char **err)
656{
657 if (too_many_args(1, args, err, NULL))
658 return -1;
659
660 if (*(args[1]) == 0) {
661 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
662 return -1;
663 }
664
665 global_tune_zlibmemlevel = atoi(args[1]);
666 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
667 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
668 return -1;
669 }
670 return 0;
671}
672
673
674/* config parser for global "tune.zlibwindowsize" */
675static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
Willy Tarreau5a1c7282021-03-09 16:55:18 +0100676 const struct proxy *defpx, const char *file, int line,
Willy Tarreau36878032016-12-22 19:46:17 +0100677 char **err)
678{
679 if (too_many_args(1, args, err, NULL))
680 return -1;
681
682 if (*(args[1]) == 0) {
683 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
684 return -1;
685 }
686
687 global_tune_zlibwindowsize = atoi(args[1]);
688 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
689 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
690 return -1;
691 }
692 return 0;
693}
694
William Lallemand82fe75c2012-10-23 10:25:10 +0200695#endif /* USE_ZLIB */
696
Willy Tarreau36878032016-12-22 19:46:17 +0100697
698/* config keyword parsers */
699static struct cfg_kw_list cfg_kws = {ILH, {
700#ifdef USE_ZLIB
701 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
702 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
703#endif
704 { 0, NULL, NULL }
705}};
706
Willy Tarreau0108d902018-11-25 19:14:37 +0100707INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
708
William Lallemand727db8b2013-04-20 17:33:20 +0200709__attribute__((constructor))
710static void __comp_fetch_init(void)
711{
Willy Tarreau36878032016-12-22 19:46:17 +0100712#if defined(USE_ZLIB) && defined(DEFAULT_MAXZLIBMEM)
Willy Tarreau3bfcd102018-11-26 10:24:45 +0100713 global.maxzlibmem = DEFAULT_MAXZLIBMEM * 1024U * 1024U;
Willy Tarreau36878032016-12-22 19:46:17 +0100714#endif
Willy Tarreau80713382018-11-26 10:19:54 +0100715}
716
717static void comp_register_build_opts(void)
718{
719 char *ptr = NULL;
720 int i;
721
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100722#ifdef USE_ZLIB
723 memprintf(&ptr, "Built with zlib version : " ZLIB_VERSION);
724 memprintf(&ptr, "%s\nRunning on zlib version : %s", ptr, zlibVersion());
725#elif defined(USE_SLZ)
726 memprintf(&ptr, "Built with libslz for stateless compression.");
Lukas Tribusb7323212017-01-11 14:24:35 +0000727#else
728 memprintf(&ptr, "Built without compression support (neither USE_ZLIB nor USE_SLZ are set).");
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100729#endif
730 memprintf(&ptr, "%s\nCompression algorithms supported :", ptr);
731
732 for (i = 0; comp_algos[i].cfg_name; i++)
733 memprintf(&ptr, "%s%s %s(\"%s\")", ptr, (i == 0 ? "" : ","), comp_algos[i].cfg_name, comp_algos[i].ua_name);
734
735 if (i == 0)
736 memprintf(&ptr, "%s none", ptr);
737
738 hap_register_build_opts(ptr, 1);
William Lallemand727db8b2013-04-20 17:33:20 +0200739}
Willy Tarreau80713382018-11-26 10:19:54 +0100740
741INITCALL0(STG_REGISTER, comp_register_build_opts);