blob: 7a7d90065e1f5cfc24e354d5f312d77c7d9aed19 [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 Bretona3a8d502021-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 */
113int comp_append_type(struct comp *comp, const char *type)
114{
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 Bretona3a8d502021-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);
122 comp_type->next = comp->types;
123 comp->types = comp_type;
124 return 0;
125}
126
127/*
128 * Add an algorithm in the configuration
Remi Tricot-Le Bretona3a8d502021-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 */
132int comp_append_algo(struct comp *comp, const char *algo)
133{
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 Bretona3a8d502021-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));
143 comp_algo->next = comp->algos;
144 comp->algos = comp_algo;
145 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 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;
Willy Tarreaud999a492020-06-14 07:50:18 +0200496 else {
497 // never matched, just to silence gcc
498 ABORT_NOW();
499 return;
500 }
William Lallemand2b502472012-10-30 14:30:39 +0100501
Willy Tarreaubafbe012017-11-24 17:34:44 +0100502 pool_free(pool, ptr);
Olivier Houchard43da3432019-03-08 18:50:27 +0100503 _HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
504 __ha_barrier_atomic_store();
William Lallemand2b502472012-10-30 14:30:39 +0100505}
506
William Lallemand82fe75c2012-10-23 10:25:10 +0200507/**************************
508**** gzip algorithm ****
509***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100510static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200511{
William Lallemand8b52bb32012-11-16 18:06:41 +0100512 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200513
William Lallemand8b52bb32012-11-16 18:06:41 +0100514 if (init_comp_ctx(comp_ctx) < 0)
515 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100516
William Lallemand8b52bb32012-11-16 18:06:41 +0100517 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200518
Willy Tarreau36878032016-12-22 19:46:17 +0100519 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 +0100520 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200521 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100522 }
523
524 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200525
526 return 0;
527}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100528
529/* Raw deflate algorithm */
530static int raw_def_init(struct comp_ctx **comp_ctx, int level)
531{
532 z_stream *strm;
533
534 if (init_comp_ctx(comp_ctx) < 0)
535 return -1;
536
537 strm = &(*comp_ctx)->strm;
538
Willy Tarreau36878032016-12-22 19:46:17 +0100539 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100540 deinit_comp_ctx(comp_ctx);
541 return -1;
542 }
543
544 (*comp_ctx)->cur_lvl = level;
545 return 0;
546}
547
William Lallemand82fe75c2012-10-23 10:25:10 +0200548/**************************
549**** Deflate algorithm ****
550***************************/
551
Willy Tarreau9f640a12015-03-28 15:46:00 +0100552static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200553{
William Lallemand8b52bb32012-11-16 18:06:41 +0100554 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200555
William Lallemand8b52bb32012-11-16 18:06:41 +0100556 if (init_comp_ctx(comp_ctx) < 0)
557 return -1;
558
559 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200560
Willy Tarreau36878032016-12-22 19:46:17 +0100561 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100562 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200563 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100564 }
565
566 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200567
568 return 0;
569}
570
William Lallemandbf3ae612012-11-19 12:35:37 +0100571/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100572static 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 +0200573{
William Lallemand82fe75c2012-10-23 10:25:10 +0200574 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100575 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200576 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200577 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200578
579 if (in_len <= 0)
580 return 0;
581
582
583 if (out_len <= 0)
584 return -1;
585
William Lallemand82fe75c2012-10-23 10:25:10 +0200586 strm->next_in = (unsigned char *)in_data;
587 strm->avail_in = in_len;
588 strm->next_out = (unsigned char *)out_data;
589 strm->avail_out = out_len;
590
591 ret = deflate(strm, Z_NO_FLUSH);
592 if (ret != Z_OK)
593 return -1;
594
595 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200596 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200597
William Lallemandbf3ae612012-11-19 12:35:37 +0100598 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200599}
600
Willy Tarreau9787efa2015-03-28 19:17:31 +0100601static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200602{
603 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200604 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100605 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200606
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200607 strm->next_in = NULL;
608 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200609 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200610 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200611
612 ret = deflate(strm, flag);
613 if (ret != Z_OK && ret != Z_STREAM_END)
614 return -1;
615
Willy Tarreaueac52592018-06-15 13:59:36 +0200616 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200617 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200618
William Lallemand072a2bf2012-11-20 17:01:01 +0100619 /* compression limit */
620 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 +0200621 (ti->idle_pct < compress_min_idle)) { /* idle */
William Lallemand072a2bf2012-11-20 17:01:01 +0100622 /* decrease level */
623 if (comp_ctx->cur_lvl > 0) {
624 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100625 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
626 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100627
628 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
629 /* increase level */
630 comp_ctx->cur_lvl++ ;
631 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100632 }
633
William Lallemand82fe75c2012-10-23 10:25:10 +0200634 return out_len;
635}
636
Willy Tarreau9787efa2015-03-28 19:17:31 +0100637static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
638{
639 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
640}
641
642static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
643{
644 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
645}
646
Willy Tarreau9f640a12015-03-28 15:46:00 +0100647static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200648{
William Lallemand8b52bb32012-11-16 18:06:41 +0100649 z_stream *strm = &(*comp_ctx)->strm;
650 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200651
William Lallemand8b52bb32012-11-16 18:06:41 +0100652 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200653
William Lallemand8b52bb32012-11-16 18:06:41 +0100654 deinit_comp_ctx(comp_ctx);
655
656 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200657}
658
Willy Tarreau36878032016-12-22 19:46:17 +0100659/* config parser for global "tune.zlibmemlevel" */
660static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
Willy Tarreau5a1c7282021-03-09 16:55:18 +0100661 const struct proxy *defpx, const char *file, int line,
Willy Tarreau36878032016-12-22 19:46:17 +0100662 char **err)
663{
664 if (too_many_args(1, args, err, NULL))
665 return -1;
666
667 if (*(args[1]) == 0) {
668 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
669 return -1;
670 }
671
672 global_tune_zlibmemlevel = atoi(args[1]);
673 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
674 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
675 return -1;
676 }
677 return 0;
678}
679
680
681/* config parser for global "tune.zlibwindowsize" */
682static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
Willy Tarreau5a1c7282021-03-09 16:55:18 +0100683 const struct proxy *defpx, const char *file, int line,
Willy Tarreau36878032016-12-22 19:46:17 +0100684 char **err)
685{
686 if (too_many_args(1, args, err, NULL))
687 return -1;
688
689 if (*(args[1]) == 0) {
690 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
691 return -1;
692 }
693
694 global_tune_zlibwindowsize = atoi(args[1]);
695 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
696 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
697 return -1;
698 }
699 return 0;
700}
701
William Lallemand82fe75c2012-10-23 10:25:10 +0200702#endif /* USE_ZLIB */
703
Willy Tarreau36878032016-12-22 19:46:17 +0100704
705/* config keyword parsers */
706static struct cfg_kw_list cfg_kws = {ILH, {
707#ifdef USE_ZLIB
708 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
709 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
710#endif
711 { 0, NULL, NULL }
712}};
713
Willy Tarreau0108d902018-11-25 19:14:37 +0100714INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
715
William Lallemand727db8b2013-04-20 17:33:20 +0200716__attribute__((constructor))
717static void __comp_fetch_init(void)
718{
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);