blob: 7b75461d2db3b4ec6b60c2a3b65f5ecbad338030 [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
Remi Tricot-Le Breton6443bcc2021-05-17 10:35:08 +0200111 * Returns 0 in case of success, 1 in case of allocation failure.
William Lallemand82fe75c2012-10-23 10:25:10 +0200112 */
Olivier Houcharddb573e92023-04-05 17:32:36 +0200113int comp_append_type(struct comp_type **types, const char *type)
William Lallemand82fe75c2012-10-23 10:25:10 +0200114{
115 struct comp_type *comp_type;
116
Vincent Bernat02779b62016-04-03 13:48:43 +0200117 comp_type = calloc(1, sizeof(*comp_type));
Remi Tricot-Le Breton6443bcc2021-05-17 10:35:08 +0200118 if (!comp_type)
119 return 1;
William Lallemand82fe75c2012-10-23 10:25:10 +0200120 comp_type->name_len = strlen(type);
121 comp_type->name = strdup(type);
Olivier Houcharddb573e92023-04-05 17:32:36 +0200122 comp_type->next = *types;
123 *types = comp_type;
William Lallemand82fe75c2012-10-23 10:25:10 +0200124 return 0;
125}
126
127/*
128 * Add an algorithm in the configuration
Remi Tricot-Le Breton6443bcc2021-05-17 10:35:08 +0200129 * Returns 0 in case of success, -1 if the <algo> is unmanaged, 1 in case of
130 * allocation failure.
William Lallemand82fe75c2012-10-23 10:25:10 +0200131 */
Olivier Houcharddb573e92023-04-05 17:32:36 +0200132int comp_append_algo(struct comp_algo **algos, const char *algo)
William Lallemand82fe75c2012-10-23 10:25:10 +0200133{
134 struct comp_algo *comp_algo;
135 int i;
136
Willy Tarreau615105e2015-03-28 16:40:46 +0100137 for (i = 0; comp_algos[i].cfg_name; i++) {
Tim Duesterhuse5ff1412021-01-02 22:31:53 +0100138 if (strcmp(algo, comp_algos[i].cfg_name) == 0) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200139 comp_algo = calloc(1, sizeof(*comp_algo));
Remi Tricot-Le Breton6443bcc2021-05-17 10:35:08 +0200140 if (!comp_algo)
141 return 1;
William Lallemand82fe75c2012-10-23 10:25:10 +0200142 memmove(comp_algo, &comp_algos[i], sizeof(struct comp_algo));
Olivier Houcharddb573e92023-04-05 17:32:36 +0200143 comp_algo->next = *algos;
144 *algos = comp_algo;
William Lallemand82fe75c2012-10-23 10:25:10 +0200145 return 0;
146 }
147 }
148 return -1;
149}
150
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200151#if defined(USE_ZLIB) || defined(USE_SLZ)
Willy Tarreau8ceae722018-11-26 11:58:30 +0100152DECLARE_STATIC_POOL(pool_comp_ctx, "comp_ctx", sizeof(struct comp_ctx));
153
William Lallemand8b52bb32012-11-16 18:06:41 +0100154/*
155 * Alloc the comp_ctx
156 */
157static inline int init_comp_ctx(struct comp_ctx **comp_ctx)
158{
159#ifdef USE_ZLIB
160 z_stream *strm;
161
William Lallemande3a7d992012-11-20 11:25:20 +0100162 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < sizeof(struct comp_ctx))
William Lallemand8b52bb32012-11-16 18:06:41 +0100163 return -1;
164#endif
165
Willy Tarreaubafbe012017-11-24 17:34:44 +0100166 *comp_ctx = pool_alloc(pool_comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100167 if (*comp_ctx == NULL)
168 return -1;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200169#if defined(USE_SLZ)
170 (*comp_ctx)->direct_ptr = NULL;
171 (*comp_ctx)->direct_len = 0;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200172 (*comp_ctx)->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200173#elif defined(USE_ZLIB)
Olivier Houchard43da3432019-03-08 18:50:27 +0100174 _HA_ATOMIC_ADD(&zlib_used_memory, sizeof(struct comp_ctx));
175 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100176
177 strm = &(*comp_ctx)->strm;
178 strm->zalloc = alloc_zlib;
179 strm->zfree = free_zlib;
180 strm->opaque = *comp_ctx;
181#endif
182 return 0;
183}
184
185/*
186 * Dealloc the comp_ctx
187 */
188static inline int deinit_comp_ctx(struct comp_ctx **comp_ctx)
189{
190 if (!*comp_ctx)
191 return 0;
192
Willy Tarreaubafbe012017-11-24 17:34:44 +0100193 pool_free(pool_comp_ctx, *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100194 *comp_ctx = NULL;
195
196#ifdef USE_ZLIB
Olivier Houchard43da3432019-03-08 18:50:27 +0100197 _HA_ATOMIC_SUB(&zlib_used_memory, sizeof(struct comp_ctx));
198 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100199#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100200 return 0;
201}
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200202#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100203
William Lallemand82fe75c2012-10-23 10:25:10 +0200204
205/****************************
206 **** Identity algorithm ****
207 ****************************/
208
209/*
210 * Init the identity algorithm
211 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100212static int identity_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200213{
214 return 0;
215}
216
217/*
218 * Process data
William Lallemandbf3ae612012-11-19 12:35:37 +0100219 * Return size of consumed data or -1 on error
William Lallemand82fe75c2012-10-23 10:25:10 +0200220 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100221static 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 +0200222{
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200223 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200224 int out_len = b_room(out);
William Lallemandbf3ae612012-11-19 12:35:37 +0100225
William Lallemand82fe75c2012-10-23 10:25:10 +0200226 if (out_len < in_len)
227 return -1;
228
229 memcpy(out_data, in_data, in_len);
230
Olivier Houchardacd14032018-06-28 18:17:23 +0200231 b_add(out, in_len);
William Lallemandbf3ae612012-11-19 12:35:37 +0100232
William Lallemand82fe75c2012-10-23 10:25:10 +0200233 return in_len;
234}
235
Willy Tarreau9787efa2015-03-28 19:17:31 +0100236static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200237{
238 return 0;
239}
240
Willy Tarreau9787efa2015-03-28 19:17:31 +0100241static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out)
242{
243 return 0;
244}
245
Willy Tarreau418b8c02015-03-29 03:32:06 +0200246/*
247 * Deinit the algorithm
248 */
249static int identity_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200250{
251 return 0;
252}
253
Willy Tarreau418b8c02015-03-29 03:32:06 +0200254
255#ifdef USE_SLZ
256
257/* SLZ's gzip format (RFC1952). Returns < 0 on error. */
258static int rfc1952_init(struct comp_ctx **comp_ctx, int level)
259{
260 if (init_comp_ctx(comp_ctx) < 0)
261 return -1;
262
263 (*comp_ctx)->cur_lvl = !!level;
264 return slz_rfc1952_init(&(*comp_ctx)->strm, !!level);
265}
266
267/* SLZ's raw deflate format (RFC1951). Returns < 0 on error. */
268static int rfc1951_init(struct comp_ctx **comp_ctx, int level)
269{
270 if (init_comp_ctx(comp_ctx) < 0)
271 return -1;
272
273 (*comp_ctx)->cur_lvl = !!level;
274 return slz_rfc1951_init(&(*comp_ctx)->strm, !!level);
275}
276
277/* SLZ's zlib format (RFC1950). Returns < 0 on error. */
278static int rfc1950_init(struct comp_ctx **comp_ctx, int level)
279{
280 if (init_comp_ctx(comp_ctx) < 0)
281 return -1;
282
283 (*comp_ctx)->cur_lvl = !!level;
284 return slz_rfc1950_init(&(*comp_ctx)->strm, !!level);
285}
286
287/* Return the size of consumed data or -1. The output buffer is unused at this
288 * point, we only keep a reference to the input data or a copy of them if the
289 * reference is already used.
William Lallemand82fe75c2012-10-23 10:25:10 +0200290 */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200291static 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 +0200292{
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200293 static THREAD_LOCAL struct buffer tmpbuf = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200294
295 if (in_len <= 0)
296 return 0;
297
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200298 if (comp_ctx->direct_ptr && b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200299 /* data already being pointed to, we're in front of fragmented
300 * data and need a buffer now. We reuse the same buffer, as it's
301 * not used out of the scope of a series of add_data()*, end().
302 */
Willy Tarreau862ad822021-03-22 16:16:22 +0100303 if (b_alloc(&tmpbuf) == NULL)
304 return -1; /* no memory */
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 Tarreau6fbf6d42023-06-26 19:34:39 +0200353 else
354 b_add(out, slz_flush(strm, b_tail(out)));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200355
Olivier Houchard0b662842018-06-29 18:16:31 +0200356 out_len = b_data(out) - out_len;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200357
358 /* very important, we must wipe the data we've just flushed */
359 comp_ctx->direct_len = 0;
360 comp_ctx->direct_ptr = NULL;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200361 comp_ctx->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200362
363 /* Verify compression rate limiting and CPU usage */
364 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
Willy Tarreau45c38e22021-09-30 18:28:49 +0200365 (th_ctx->idle_pct < compress_min_idle)) { /* idle */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200366 if (comp_ctx->cur_lvl > 0)
367 strm->level = --comp_ctx->cur_lvl;
368 }
369 else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel && comp_ctx->cur_lvl < 1) {
370 strm->level = ++comp_ctx->cur_lvl;
371 }
372
373 /* and that's all */
374 return out_len;
375}
376
377static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out)
378{
379 return rfc195x_flush_or_finish(comp_ctx, out, 0);
380}
381
382static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out)
383{
384 return rfc195x_flush_or_finish(comp_ctx, out, 1);
385}
386
387/* we just need to free the comp_ctx here, nothing was allocated */
388static int rfc195x_end(struct comp_ctx **comp_ctx)
389{
390 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200391 return 0;
392}
393
Willy Tarreau418b8c02015-03-29 03:32:06 +0200394#elif defined(USE_ZLIB) /* ! USE_SLZ */
William Lallemand82fe75c2012-10-23 10:25:10 +0200395
William Lallemand2b502472012-10-30 14:30:39 +0100396/*
397 * This is a tricky allocation function using the zlib.
398 * This is based on the allocation order in deflateInit2.
399 */
400static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size)
401{
402 struct comp_ctx *ctx = opaque;
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200403 static THREAD_LOCAL char round = 0; /* order in deflateInit2 */
William Lallemand2b502472012-10-30 14:30:39 +0100404 void *buf = NULL;
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100405 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100406
William Lallemande3a7d992012-11-20 11:25:20 +0100407 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < (long)(items * size))
William Lallemand9d5f5482012-11-07 16:12:57 +0100408 goto end;
William Lallemand9d5f5482012-11-07 16:12:57 +0100409
William Lallemand2b502472012-10-30 14:30:39 +0100410 switch (round) {
411 case 0:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200412 if (zlib_pool_deflate_state == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100413 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200414 if (zlib_pool_deflate_state == NULL)
415 zlib_pool_deflate_state = create_pool("zlib_state", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100416 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200417 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100418 pool = zlib_pool_deflate_state;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100419 ctx->zlib_deflate_state = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100420 break;
421
422 case 1:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200423 if (zlib_pool_window == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100424 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200425 if (zlib_pool_window == NULL)
426 zlib_pool_window = create_pool("zlib_window", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100427 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200428 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100429 pool = zlib_pool_window;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100430 ctx->zlib_window = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100431 break;
432
433 case 2:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200434 if (zlib_pool_prev == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100435 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200436 if (zlib_pool_prev == NULL)
437 zlib_pool_prev = create_pool("zlib_prev", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100438 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200439 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100440 pool = zlib_pool_prev;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100441 ctx->zlib_prev = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100442 break;
443
444 case 3:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200445 if (zlib_pool_head == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100446 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200447 if (zlib_pool_head == NULL)
448 zlib_pool_head = create_pool("zlib_head", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100449 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200450 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100451 pool = zlib_pool_head;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100452 ctx->zlib_head = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100453 break;
454
455 case 4:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200456 if (zlib_pool_pending_buf == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100457 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200458 if (zlib_pool_pending_buf == NULL)
459 zlib_pool_pending_buf = create_pool("zlib_pending_buf", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100460 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200461 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100462 pool = zlib_pool_pending_buf;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100463 ctx->zlib_pending_buf = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100464 break;
465 }
Olivier Houchard43da3432019-03-08 18:50:27 +0100466 if (buf != NULL) {
467 _HA_ATOMIC_ADD(&zlib_used_memory, pool->size);
468 __ha_barrier_atomic_store();
469 }
William Lallemand9d5f5482012-11-07 16:12:57 +0100470
471end:
William Lallemand2b502472012-10-30 14:30:39 +0100472
Willy Tarreau46909852012-11-15 14:57:56 +0100473 /* deflateInit2() first allocates and checks the deflate_state, then if
474 * it succeeds, it allocates all other 4 areas at ones and checks them
475 * at the end. So we want to correctly count the rounds depending on when
476 * zlib is supposed to abort.
477 */
478 if (buf || round)
479 round = (round + 1) % 5;
William Lallemand2b502472012-10-30 14:30:39 +0100480 return buf;
481}
482
483static void free_zlib(void *opaque, void *ptr)
484{
485 struct comp_ctx *ctx = opaque;
Willy Tarreaub1fbd052012-11-10 17:49:37 +0100486 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100487
488 if (ptr == ctx->zlib_window)
William Lallemand9d5f5482012-11-07 16:12:57 +0100489 pool = zlib_pool_window;
William Lallemand2b502472012-10-30 14:30:39 +0100490 else if (ptr == ctx->zlib_deflate_state)
William Lallemand9d5f5482012-11-07 16:12:57 +0100491 pool = zlib_pool_deflate_state;
William Lallemand2b502472012-10-30 14:30:39 +0100492 else if (ptr == ctx->zlib_prev)
William Lallemand9d5f5482012-11-07 16:12:57 +0100493 pool = zlib_pool_prev;
William Lallemand2b502472012-10-30 14:30:39 +0100494 else if (ptr == ctx->zlib_head)
William Lallemand9d5f5482012-11-07 16:12:57 +0100495 pool = zlib_pool_head;
William Lallemand2b502472012-10-30 14:30:39 +0100496 else if (ptr == ctx->zlib_pending_buf)
William Lallemand9d5f5482012-11-07 16:12:57 +0100497 pool = zlib_pool_pending_buf;
Willy Tarreaud999a492020-06-14 07:50:18 +0200498 else {
499 // never matched, just to silence gcc
500 ABORT_NOW();
501 return;
502 }
William Lallemand2b502472012-10-30 14:30:39 +0100503
Willy Tarreaubafbe012017-11-24 17:34:44 +0100504 pool_free(pool, ptr);
Olivier Houchard43da3432019-03-08 18:50:27 +0100505 _HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
506 __ha_barrier_atomic_store();
William Lallemand2b502472012-10-30 14:30:39 +0100507}
508
William Lallemand82fe75c2012-10-23 10:25:10 +0200509/**************************
510**** gzip algorithm ****
511***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100512static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200513{
William Lallemand8b52bb32012-11-16 18:06:41 +0100514 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200515
William Lallemand8b52bb32012-11-16 18:06:41 +0100516 if (init_comp_ctx(comp_ctx) < 0)
517 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100518
William Lallemand8b52bb32012-11-16 18:06:41 +0100519 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200520
Willy Tarreau36878032016-12-22 19:46:17 +0100521 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 +0100522 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200523 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100524 }
525
526 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200527
528 return 0;
529}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100530
531/* Raw deflate algorithm */
532static int raw_def_init(struct comp_ctx **comp_ctx, int level)
533{
534 z_stream *strm;
535
536 if (init_comp_ctx(comp_ctx) < 0)
537 return -1;
538
539 strm = &(*comp_ctx)->strm;
540
Willy Tarreau36878032016-12-22 19:46:17 +0100541 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100542 deinit_comp_ctx(comp_ctx);
543 return -1;
544 }
545
546 (*comp_ctx)->cur_lvl = level;
547 return 0;
548}
549
William Lallemand82fe75c2012-10-23 10:25:10 +0200550/**************************
551**** Deflate algorithm ****
552***************************/
553
Willy Tarreau9f640a12015-03-28 15:46:00 +0100554static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200555{
William Lallemand8b52bb32012-11-16 18:06:41 +0100556 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200557
William Lallemand8b52bb32012-11-16 18:06:41 +0100558 if (init_comp_ctx(comp_ctx) < 0)
559 return -1;
560
561 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200562
Willy Tarreau36878032016-12-22 19:46:17 +0100563 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100564 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200565 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100566 }
567
568 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200569
570 return 0;
571}
572
William Lallemandbf3ae612012-11-19 12:35:37 +0100573/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100574static 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 +0200575{
William Lallemand82fe75c2012-10-23 10:25:10 +0200576 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100577 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200578 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200579 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200580
581 if (in_len <= 0)
582 return 0;
583
584
585 if (out_len <= 0)
586 return -1;
587
William Lallemand82fe75c2012-10-23 10:25:10 +0200588 strm->next_in = (unsigned char *)in_data;
589 strm->avail_in = in_len;
590 strm->next_out = (unsigned char *)out_data;
591 strm->avail_out = out_len;
592
593 ret = deflate(strm, Z_NO_FLUSH);
594 if (ret != Z_OK)
595 return -1;
596
597 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200598 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200599
William Lallemandbf3ae612012-11-19 12:35:37 +0100600 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200601}
602
Willy Tarreau9787efa2015-03-28 19:17:31 +0100603static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200604{
605 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200606 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100607 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200608
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200609 strm->next_in = NULL;
610 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200611 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200612 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200613
614 ret = deflate(strm, flag);
615 if (ret != Z_OK && ret != Z_STREAM_END)
616 return -1;
617
Willy Tarreaueac52592018-06-15 13:59:36 +0200618 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200619 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200620
William Lallemand072a2bf2012-11-20 17:01:01 +0100621 /* compression limit */
622 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
Willy Tarreau45c38e22021-09-30 18:28:49 +0200623 (th_ctx->idle_pct < compress_min_idle)) { /* idle */
William Lallemand072a2bf2012-11-20 17:01:01 +0100624 /* decrease level */
625 if (comp_ctx->cur_lvl > 0) {
626 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100627 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
628 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100629
630 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
631 /* increase level */
632 comp_ctx->cur_lvl++ ;
633 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100634 }
635
William Lallemand82fe75c2012-10-23 10:25:10 +0200636 return out_len;
637}
638
Willy Tarreau9787efa2015-03-28 19:17:31 +0100639static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
640{
641 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
642}
643
644static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
645{
646 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
647}
648
Willy Tarreau9f640a12015-03-28 15:46:00 +0100649static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200650{
William Lallemand8b52bb32012-11-16 18:06:41 +0100651 z_stream *strm = &(*comp_ctx)->strm;
652 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200653
William Lallemand8b52bb32012-11-16 18:06:41 +0100654 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200655
William Lallemand8b52bb32012-11-16 18:06:41 +0100656 deinit_comp_ctx(comp_ctx);
657
658 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200659}
660
Willy Tarreau36878032016-12-22 19:46:17 +0100661/* config parser for global "tune.zlibmemlevel" */
662static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
Willy Tarreau5a1c7282021-03-09 16:55:18 +0100663 const struct proxy *defpx, const char *file, int line,
Willy Tarreau36878032016-12-22 19:46:17 +0100664 char **err)
665{
666 if (too_many_args(1, args, err, NULL))
667 return -1;
668
669 if (*(args[1]) == 0) {
670 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
671 return -1;
672 }
673
674 global_tune_zlibmemlevel = atoi(args[1]);
675 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
676 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
677 return -1;
678 }
679 return 0;
680}
681
682
683/* config parser for global "tune.zlibwindowsize" */
684static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
Willy Tarreau5a1c7282021-03-09 16:55:18 +0100685 const struct proxy *defpx, const char *file, int line,
Willy Tarreau36878032016-12-22 19:46:17 +0100686 char **err)
687{
688 if (too_many_args(1, args, err, NULL))
689 return -1;
690
691 if (*(args[1]) == 0) {
692 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
693 return -1;
694 }
695
696 global_tune_zlibwindowsize = atoi(args[1]);
697 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
698 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
699 return -1;
700 }
701 return 0;
702}
703
William Lallemand82fe75c2012-10-23 10:25:10 +0200704#endif /* USE_ZLIB */
705
Willy Tarreau36878032016-12-22 19:46:17 +0100706
707/* config keyword parsers */
708static struct cfg_kw_list cfg_kws = {ILH, {
709#ifdef USE_ZLIB
710 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
711 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
712#endif
713 { 0, NULL, NULL }
714}};
715
Willy Tarreau0108d902018-11-25 19:14:37 +0100716INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
717
Willy Tarreau80713382018-11-26 10:19:54 +0100718static void comp_register_build_opts(void)
719{
720 char *ptr = NULL;
721 int i;
722
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100723#ifdef USE_ZLIB
724 memprintf(&ptr, "Built with zlib version : " ZLIB_VERSION);
725 memprintf(&ptr, "%s\nRunning on zlib version : %s", ptr, zlibVersion());
726#elif defined(USE_SLZ)
727 memprintf(&ptr, "Built with libslz for stateless compression.");
Lukas Tribusb7323212017-01-11 14:24:35 +0000728#else
729 memprintf(&ptr, "Built without compression support (neither USE_ZLIB nor USE_SLZ are set).");
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100730#endif
731 memprintf(&ptr, "%s\nCompression algorithms supported :", ptr);
732
733 for (i = 0; comp_algos[i].cfg_name; i++)
734 memprintf(&ptr, "%s%s %s(\"%s\")", ptr, (i == 0 ? "" : ","), comp_algos[i].cfg_name, comp_algos[i].ua_name);
735
736 if (i == 0)
737 memprintf(&ptr, "%s none", ptr);
738
739 hap_register_build_opts(ptr, 1);
William Lallemand727db8b2013-04-20 17:33:20 +0200740}
Willy Tarreau80713382018-11-26 10:19:54 +0100741
742INITCALL0(STG_REGISTER, comp_register_build_opts);