blob: f55ce62f9ce7b0b3f5ec2bb390201c43ef634023 [file] [log] [blame]
William Lallemand82fe75c2012-10-23 10:25:10 +02001/*
2 * HTTP compression.
3 *
4 * Copyright 2012 Exceliance, David Du Colombier <dducolombier@exceliance.fr>
5 * William Lallemand <wlallemand@exceliance.fr>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
11 *
12 */
13
14#include <stdio.h>
Willy Tarreau34763642012-10-26 15:05:35 +020015
Willy Tarreau418b8c02015-03-29 03:32:06 +020016#if defined(USE_SLZ)
17#include <slz.h>
18#elif defined(USE_ZLIB)
Willy Tarreau34763642012-10-26 15:05:35 +020019/* Note: the crappy zlib and openssl libs both define the "free_func" type.
20 * That's a very clever idea to use such a generic name in general purpose
21 * libraries, really... The zlib one is easier to redefine than openssl's,
22 * so let's only fix this one.
23 */
24#define free_func zlib_free_func
William Lallemand82fe75c2012-10-23 10:25:10 +020025#include <zlib.h>
Willy Tarreau34763642012-10-26 15:05:35 +020026#undef free_func
William Lallemand08289f12012-10-31 11:19:18 +010027#endif /* USE_ZLIB */
William Lallemand82fe75c2012-10-23 10:25:10 +020028
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020029#include <haproxy/api.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020030#include <haproxy/cfgparse.h>
Willy Tarreau0a3bd392020-06-04 08:52:38 +020031#include <haproxy/compression-t.h>
Willy Tarreau0a3bd392020-06-04 08:52:38 +020032#include <haproxy/compression.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/dynbuf.h>
Willy Tarreau66347942020-06-01 12:18:08 +020034#include <haproxy/freq_ctr.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020035#include <haproxy/global.h>
36#include <haproxy/pool.h>
37#include <haproxy/stream.h>
38#include <haproxy/thread.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020039
William Lallemand2b502472012-10-30 14:30:39 +010040
Willy Tarreaue5489742018-11-26 14:44:03 +010041#if defined(USE_ZLIB)
Willy Tarreau86abe442018-11-25 20:12:18 +010042__decl_spinlock(comp_pool_lock);
Emeric Brun11f58862017-11-07 11:57:54 +010043#endif
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +020044
William Lallemand2b502472012-10-30 14:30:39 +010045#ifdef USE_ZLIB
46
William Lallemand8b52bb32012-11-16 18:06:41 +010047static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size);
48static void free_zlib(void *opaque, void *ptr);
49
William Lallemand2b502472012-10-30 14:30:39 +010050/* zlib allocation */
51static struct pool_head *zlib_pool_deflate_state = NULL;
52static struct pool_head *zlib_pool_window = NULL;
53static struct pool_head *zlib_pool_prev = NULL;
54static struct pool_head *zlib_pool_head = NULL;
55static struct pool_head *zlib_pool_pending_buf = NULL;
56
William Lallemande3a7d992012-11-20 11:25:20 +010057long zlib_used_memory = 0;
William Lallemand9d5f5482012-11-07 16:12:57 +010058
Willy Tarreau36878032016-12-22 19:46:17 +010059static int global_tune_zlibmemlevel = 8; /* zlib memlevel */
60static int global_tune_zlibwindowsize = MAX_WBITS; /* zlib window size */
61
William Lallemand2b502472012-10-30 14:30:39 +010062#endif
63
William Lallemand072a2bf2012-11-20 17:01:01 +010064unsigned int compress_min_idle = 0;
William Lallemand8b52bb32012-11-16 18:06:41 +010065
Willy Tarreau9f640a12015-03-28 15:46:00 +010066static int identity_init(struct comp_ctx **comp_ctx, int level);
67static 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 +010068static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out);
69static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010070static int identity_end(struct comp_ctx **comp_ctx);
71
Willy Tarreau418b8c02015-03-29 03:32:06 +020072#if defined(USE_SLZ)
73
74static int rfc1950_init(struct comp_ctx **comp_ctx, int level);
75static int rfc1951_init(struct comp_ctx **comp_ctx, int level);
76static int rfc1952_init(struct comp_ctx **comp_ctx, int level);
77static int rfc195x_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
78static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out);
79static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out);
80static int rfc195x_end(struct comp_ctx **comp_ctx);
81
82#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +010083
Willy Tarreau9f640a12015-03-28 15:46:00 +010084static int gzip_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreauc91840a2015-03-28 17:00:39 +010085static int raw_def_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreau9f640a12015-03-28 15:46:00 +010086static int deflate_init(struct comp_ctx **comp_ctx, int level);
87static 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 +010088static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out);
89static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010090static int deflate_end(struct comp_ctx **comp_ctx);
Willy Tarreau7b218772015-03-28 22:08:25 +010091
Willy Tarreau9f640a12015-03-28 15:46:00 +010092#endif /* USE_ZLIB */
93
William Lallemand2b502472012-10-30 14:30:39 +010094
Cyril Bonté6162c432012-11-10 19:27:47 +010095const struct comp_algo comp_algos[] =
William Lallemand82fe75c2012-10-23 10:25:10 +020096{
Willy Tarreau7b218772015-03-28 22:08:25 +010097 { "identity", 8, "identity", 8, identity_init, identity_add_data, identity_flush, identity_finish, identity_end },
Willy Tarreau418b8c02015-03-29 03:32:06 +020098#if defined(USE_SLZ)
99 { "deflate", 7, "deflate", 7, rfc1950_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
100 { "raw-deflate", 11, "deflate", 7, rfc1951_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
101 { "gzip", 4, "gzip", 4, rfc1952_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
102#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +0100103 { "deflate", 7, "deflate", 7, deflate_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
104 { "raw-deflate", 11, "deflate", 7, raw_def_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
105 { "gzip", 4, "gzip", 4, gzip_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
William Lallemand82fe75c2012-10-23 10:25:10 +0200106#endif /* USE_ZLIB */
Willy Tarreau615105e2015-03-28 16:40:46 +0100107 { NULL, 0, NULL, 0, NULL , NULL, NULL, NULL, NULL }
William Lallemand82fe75c2012-10-23 10:25:10 +0200108};
109
110/*
111 * Add a content-type in the configuration
Remi Tricot-Le Breton46bd5dc2021-05-17 10:35:08 +0200112 * Returns 0 in case of success, 1 in case of allocation failure.
William Lallemand82fe75c2012-10-23 10:25:10 +0200113 */
114int comp_append_type(struct comp *comp, const char *type)
115{
116 struct comp_type *comp_type;
117
Vincent Bernat02779b62016-04-03 13:48:43 +0200118 comp_type = calloc(1, sizeof(*comp_type));
Remi Tricot-Le Breton46bd5dc2021-05-17 10:35:08 +0200119 if (!comp_type)
120 return 1;
William Lallemand82fe75c2012-10-23 10:25:10 +0200121 comp_type->name_len = strlen(type);
122 comp_type->name = strdup(type);
123 comp_type->next = comp->types;
124 comp->types = comp_type;
125 return 0;
126}
127
128/*
129 * Add an algorithm in the configuration
Remi Tricot-Le Breton46bd5dc2021-05-17 10:35:08 +0200130 * Returns 0 in case of success, -1 if the <algo> is unmanaged, 1 in case of
131 * allocation failure.
William Lallemand82fe75c2012-10-23 10:25:10 +0200132 */
133int comp_append_algo(struct comp *comp, const char *algo)
134{
135 struct comp_algo *comp_algo;
136 int i;
137
Willy Tarreau615105e2015-03-28 16:40:46 +0100138 for (i = 0; comp_algos[i].cfg_name; i++) {
139 if (!strcmp(algo, comp_algos[i].cfg_name)) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200140 comp_algo = calloc(1, sizeof(*comp_algo));
Remi Tricot-Le Breton46bd5dc2021-05-17 10:35:08 +0200141 if (!comp_algo)
142 return 1;
William Lallemand82fe75c2012-10-23 10:25:10 +0200143 memmove(comp_algo, &comp_algos[i], sizeof(struct comp_algo));
144 comp_algo->next = comp->algos;
145 comp->algos = comp_algo;
146 return 0;
147 }
148 }
149 return -1;
150}
151
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200152#if defined(USE_ZLIB) || defined(USE_SLZ)
Willy Tarreau8ceae722018-11-26 11:58:30 +0100153DECLARE_STATIC_POOL(pool_comp_ctx, "comp_ctx", sizeof(struct comp_ctx));
154
William Lallemand8b52bb32012-11-16 18:06:41 +0100155/*
156 * Alloc the comp_ctx
157 */
158static inline int init_comp_ctx(struct comp_ctx **comp_ctx)
159{
160#ifdef USE_ZLIB
161 z_stream *strm;
162
William Lallemande3a7d992012-11-20 11:25:20 +0100163 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < sizeof(struct comp_ctx))
William Lallemand8b52bb32012-11-16 18:06:41 +0100164 return -1;
165#endif
166
Willy Tarreaubafbe012017-11-24 17:34:44 +0100167 *comp_ctx = pool_alloc(pool_comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100168 if (*comp_ctx == NULL)
169 return -1;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200170#if defined(USE_SLZ)
171 (*comp_ctx)->direct_ptr = NULL;
172 (*comp_ctx)->direct_len = 0;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200173 (*comp_ctx)->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200174#elif defined(USE_ZLIB)
Olivier Houchard43da3432019-03-08 18:50:27 +0100175 _HA_ATOMIC_ADD(&zlib_used_memory, sizeof(struct comp_ctx));
176 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100177
178 strm = &(*comp_ctx)->strm;
179 strm->zalloc = alloc_zlib;
180 strm->zfree = free_zlib;
181 strm->opaque = *comp_ctx;
182#endif
183 return 0;
184}
185
186/*
187 * Dealloc the comp_ctx
188 */
189static inline int deinit_comp_ctx(struct comp_ctx **comp_ctx)
190{
191 if (!*comp_ctx)
192 return 0;
193
Willy Tarreaubafbe012017-11-24 17:34:44 +0100194 pool_free(pool_comp_ctx, *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100195 *comp_ctx = NULL;
196
197#ifdef USE_ZLIB
Olivier Houchard43da3432019-03-08 18:50:27 +0100198 _HA_ATOMIC_SUB(&zlib_used_memory, sizeof(struct comp_ctx));
199 __ha_barrier_atomic_store();
William Lallemand8b52bb32012-11-16 18:06:41 +0100200#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100201 return 0;
202}
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200203#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100204
William Lallemand82fe75c2012-10-23 10:25:10 +0200205
206/****************************
207 **** Identity algorithm ****
208 ****************************/
209
210/*
211 * Init the identity algorithm
212 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100213static int identity_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200214{
215 return 0;
216}
217
218/*
219 * Process data
William Lallemandbf3ae612012-11-19 12:35:37 +0100220 * Return size of consumed data or -1 on error
William Lallemand82fe75c2012-10-23 10:25:10 +0200221 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100222static 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 +0200223{
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200224 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200225 int out_len = b_room(out);
William Lallemandbf3ae612012-11-19 12:35:37 +0100226
William Lallemand82fe75c2012-10-23 10:25:10 +0200227 if (out_len < in_len)
228 return -1;
229
230 memcpy(out_data, in_data, in_len);
231
Olivier Houchardacd14032018-06-28 18:17:23 +0200232 b_add(out, in_len);
William Lallemandbf3ae612012-11-19 12:35:37 +0100233
William Lallemand82fe75c2012-10-23 10:25:10 +0200234 return in_len;
235}
236
Willy Tarreau9787efa2015-03-28 19:17:31 +0100237static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200238{
239 return 0;
240}
241
Willy Tarreau9787efa2015-03-28 19:17:31 +0100242static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out)
243{
244 return 0;
245}
246
Willy Tarreau418b8c02015-03-29 03:32:06 +0200247/*
248 * Deinit the algorithm
249 */
250static int identity_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200251{
252 return 0;
253}
254
Willy Tarreau418b8c02015-03-29 03:32:06 +0200255
256#ifdef USE_SLZ
257
258/* SLZ's gzip format (RFC1952). Returns < 0 on error. */
259static int rfc1952_init(struct comp_ctx **comp_ctx, int level)
260{
261 if (init_comp_ctx(comp_ctx) < 0)
262 return -1;
263
264 (*comp_ctx)->cur_lvl = !!level;
265 return slz_rfc1952_init(&(*comp_ctx)->strm, !!level);
266}
267
268/* SLZ's raw deflate format (RFC1951). Returns < 0 on error. */
269static int rfc1951_init(struct comp_ctx **comp_ctx, int level)
270{
271 if (init_comp_ctx(comp_ctx) < 0)
272 return -1;
273
274 (*comp_ctx)->cur_lvl = !!level;
275 return slz_rfc1951_init(&(*comp_ctx)->strm, !!level);
276}
277
278/* SLZ's zlib format (RFC1950). Returns < 0 on error. */
279static int rfc1950_init(struct comp_ctx **comp_ctx, int level)
280{
281 if (init_comp_ctx(comp_ctx) < 0)
282 return -1;
283
284 (*comp_ctx)->cur_lvl = !!level;
285 return slz_rfc1950_init(&(*comp_ctx)->strm, !!level);
286}
287
288/* Return the size of consumed data or -1. The output buffer is unused at this
289 * point, we only keep a reference to the input data or a copy of them if the
290 * reference is already used.
William Lallemand82fe75c2012-10-23 10:25:10 +0200291 */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200292static 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 +0200293{
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200294 static THREAD_LOCAL struct buffer tmpbuf = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200295
296 if (in_len <= 0)
297 return 0;
298
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200299 if (comp_ctx->direct_ptr && b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200300 /* data already being pointed to, we're in front of fragmented
301 * data and need a buffer now. We reuse the same buffer, as it's
302 * not used out of the scope of a series of add_data()*, end().
303 */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200304 if (unlikely(!tmpbuf.size)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200305 /* this is the first time we need the compression buffer */
306 if (b_alloc(&tmpbuf) == NULL)
307 return -1; /* no memory */
308 }
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200309 b_reset(&tmpbuf);
310 memcpy(b_tail(&tmpbuf), comp_ctx->direct_ptr, comp_ctx->direct_len);
311 b_add(&tmpbuf, comp_ctx->direct_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200312 comp_ctx->direct_ptr = NULL;
313 comp_ctx->direct_len = 0;
314 comp_ctx->queued = tmpbuf;
315 /* fall through buffer copy */
316 }
317
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200318 if (!b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200319 /* data already pending */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200320 memcpy(b_tail(&comp_ctx->queued), in_data, in_len);
321 b_add(&comp_ctx->queued, in_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200322 return in_len;
323 }
324
325 comp_ctx->direct_ptr = in_data;
326 comp_ctx->direct_len = in_len;
327 return in_len;
328}
329
330/* Compresses the data accumulated using add_data(), and optionally sends the
331 * format-specific trailer if <finish> is non-null. <out> is expected to have a
332 * large enough free non-wrapping space as verified by http_comp_buffer_init().
333 * The number of bytes emitted is reported.
334 */
335static int rfc195x_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int finish)
336{
337 struct slz_stream *strm = &comp_ctx->strm;
338 const char *in_ptr;
339 int in_len;
340 int out_len;
341
342 in_ptr = comp_ctx->direct_ptr;
343 in_len = comp_ctx->direct_len;
344
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200345 if (!b_is_null(&comp_ctx->queued)) {
346 in_ptr = b_head(&comp_ctx->queued);
347 in_len = b_data(&comp_ctx->queued);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200348 }
349
Olivier Houchard0b662842018-06-29 18:16:31 +0200350 out_len = b_data(out);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200351
352 if (in_ptr)
Olivier Houchardacd14032018-06-28 18:17:23 +0200353 b_add(out, slz_encode(strm, b_tail(out), in_ptr, in_len, !finish));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200354
355 if (finish)
Olivier Houchardacd14032018-06-28 18:17:23 +0200356 b_add(out, slz_finish(strm, b_tail(out)));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200357
Olivier Houchard0b662842018-06-29 18:16:31 +0200358 out_len = b_data(out) - out_len;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200359
360 /* very important, we must wipe the data we've just flushed */
361 comp_ctx->direct_len = 0;
362 comp_ctx->direct_ptr = NULL;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200363 comp_ctx->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200364
365 /* Verify compression rate limiting and CPU usage */
366 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 +0200367 (ti->idle_pct < compress_min_idle)) { /* idle */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200368 if (comp_ctx->cur_lvl > 0)
369 strm->level = --comp_ctx->cur_lvl;
370 }
371 else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel && comp_ctx->cur_lvl < 1) {
372 strm->level = ++comp_ctx->cur_lvl;
373 }
374
375 /* and that's all */
376 return out_len;
377}
378
379static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out)
380{
381 return rfc195x_flush_or_finish(comp_ctx, out, 0);
382}
383
384static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out)
385{
386 return rfc195x_flush_or_finish(comp_ctx, out, 1);
387}
388
389/* we just need to free the comp_ctx here, nothing was allocated */
390static int rfc195x_end(struct comp_ctx **comp_ctx)
391{
392 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200393 return 0;
394}
395
Willy Tarreau418b8c02015-03-29 03:32:06 +0200396#elif defined(USE_ZLIB) /* ! USE_SLZ */
William Lallemand82fe75c2012-10-23 10:25:10 +0200397
William Lallemand2b502472012-10-30 14:30:39 +0100398/*
399 * This is a tricky allocation function using the zlib.
400 * This is based on the allocation order in deflateInit2.
401 */
402static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size)
403{
404 struct comp_ctx *ctx = opaque;
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200405 static THREAD_LOCAL char round = 0; /* order in deflateInit2 */
William Lallemand2b502472012-10-30 14:30:39 +0100406 void *buf = NULL;
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100407 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100408
William Lallemande3a7d992012-11-20 11:25:20 +0100409 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < (long)(items * size))
William Lallemand9d5f5482012-11-07 16:12:57 +0100410 goto end;
William Lallemand9d5f5482012-11-07 16:12:57 +0100411
William Lallemand2b502472012-10-30 14:30:39 +0100412 switch (round) {
413 case 0:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200414 if (zlib_pool_deflate_state == 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_deflate_state == NULL)
417 zlib_pool_deflate_state = create_pool("zlib_state", 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_deflate_state;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100421 ctx->zlib_deflate_state = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100422 break;
423
424 case 1:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200425 if (zlib_pool_window == 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_window == NULL)
428 zlib_pool_window = create_pool("zlib_window", 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_window;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100432 ctx->zlib_window = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100433 break;
434
435 case 2:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200436 if (zlib_pool_prev == 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_prev == NULL)
439 zlib_pool_prev = create_pool("zlib_prev", 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_prev;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100443 ctx->zlib_prev = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100444 break;
445
446 case 3:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200447 if (zlib_pool_head == 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_head == NULL)
450 zlib_pool_head = create_pool("zlib_head", 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_head;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100454 ctx->zlib_head = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100455 break;
456
457 case 4:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200458 if (zlib_pool_pending_buf == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100459 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200460 if (zlib_pool_pending_buf == NULL)
461 zlib_pool_pending_buf = create_pool("zlib_pending_buf", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100462 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200463 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100464 pool = zlib_pool_pending_buf;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100465 ctx->zlib_pending_buf = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100466 break;
467 }
Olivier Houchard43da3432019-03-08 18:50:27 +0100468 if (buf != NULL) {
469 _HA_ATOMIC_ADD(&zlib_used_memory, pool->size);
470 __ha_barrier_atomic_store();
471 }
William Lallemand9d5f5482012-11-07 16:12:57 +0100472
473end:
William Lallemand2b502472012-10-30 14:30:39 +0100474
Willy Tarreau46909852012-11-15 14:57:56 +0100475 /* deflateInit2() first allocates and checks the deflate_state, then if
476 * it succeeds, it allocates all other 4 areas at ones and checks them
477 * at the end. So we want to correctly count the rounds depending on when
478 * zlib is supposed to abort.
479 */
480 if (buf || round)
481 round = (round + 1) % 5;
William Lallemand2b502472012-10-30 14:30:39 +0100482 return buf;
483}
484
485static void free_zlib(void *opaque, void *ptr)
486{
487 struct comp_ctx *ctx = opaque;
Willy Tarreaub1fbd052012-11-10 17:49:37 +0100488 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100489
490 if (ptr == ctx->zlib_window)
William Lallemand9d5f5482012-11-07 16:12:57 +0100491 pool = zlib_pool_window;
William Lallemand2b502472012-10-30 14:30:39 +0100492 else if (ptr == ctx->zlib_deflate_state)
William Lallemand9d5f5482012-11-07 16:12:57 +0100493 pool = zlib_pool_deflate_state;
William Lallemand2b502472012-10-30 14:30:39 +0100494 else if (ptr == ctx->zlib_prev)
William Lallemand9d5f5482012-11-07 16:12:57 +0100495 pool = zlib_pool_prev;
William Lallemand2b502472012-10-30 14:30:39 +0100496 else if (ptr == ctx->zlib_head)
William Lallemand9d5f5482012-11-07 16:12:57 +0100497 pool = zlib_pool_head;
William Lallemand2b502472012-10-30 14:30:39 +0100498 else if (ptr == ctx->zlib_pending_buf)
William Lallemand9d5f5482012-11-07 16:12:57 +0100499 pool = zlib_pool_pending_buf;
Willy Tarreaud999a492020-06-14 07:50:18 +0200500 else {
501 // never matched, just to silence gcc
502 ABORT_NOW();
503 return;
504 }
William Lallemand2b502472012-10-30 14:30:39 +0100505
Willy Tarreaubafbe012017-11-24 17:34:44 +0100506 pool_free(pool, ptr);
Olivier Houchard43da3432019-03-08 18:50:27 +0100507 _HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
508 __ha_barrier_atomic_store();
William Lallemand2b502472012-10-30 14:30:39 +0100509}
510
William Lallemand82fe75c2012-10-23 10:25:10 +0200511/**************************
512**** gzip algorithm ****
513***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100514static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200515{
William Lallemand8b52bb32012-11-16 18:06:41 +0100516 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200517
William Lallemand8b52bb32012-11-16 18:06:41 +0100518 if (init_comp_ctx(comp_ctx) < 0)
519 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100520
William Lallemand8b52bb32012-11-16 18:06:41 +0100521 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200522
Willy Tarreau36878032016-12-22 19:46:17 +0100523 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 +0100524 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200525 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100526 }
527
528 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200529
530 return 0;
531}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100532
533/* Raw deflate algorithm */
534static int raw_def_init(struct comp_ctx **comp_ctx, int level)
535{
536 z_stream *strm;
537
538 if (init_comp_ctx(comp_ctx) < 0)
539 return -1;
540
541 strm = &(*comp_ctx)->strm;
542
Willy Tarreau36878032016-12-22 19:46:17 +0100543 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100544 deinit_comp_ctx(comp_ctx);
545 return -1;
546 }
547
548 (*comp_ctx)->cur_lvl = level;
549 return 0;
550}
551
William Lallemand82fe75c2012-10-23 10:25:10 +0200552/**************************
553**** Deflate algorithm ****
554***************************/
555
Willy Tarreau9f640a12015-03-28 15:46:00 +0100556static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200557{
William Lallemand8b52bb32012-11-16 18:06:41 +0100558 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200559
William Lallemand8b52bb32012-11-16 18:06:41 +0100560 if (init_comp_ctx(comp_ctx) < 0)
561 return -1;
562
563 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200564
Willy Tarreau36878032016-12-22 19:46:17 +0100565 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100566 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200567 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100568 }
569
570 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200571
572 return 0;
573}
574
William Lallemandbf3ae612012-11-19 12:35:37 +0100575/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100576static 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 +0200577{
William Lallemand82fe75c2012-10-23 10:25:10 +0200578 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100579 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200580 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200581 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200582
583 if (in_len <= 0)
584 return 0;
585
586
587 if (out_len <= 0)
588 return -1;
589
William Lallemand82fe75c2012-10-23 10:25:10 +0200590 strm->next_in = (unsigned char *)in_data;
591 strm->avail_in = in_len;
592 strm->next_out = (unsigned char *)out_data;
593 strm->avail_out = out_len;
594
595 ret = deflate(strm, Z_NO_FLUSH);
596 if (ret != Z_OK)
597 return -1;
598
599 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200600 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200601
William Lallemandbf3ae612012-11-19 12:35:37 +0100602 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200603}
604
Willy Tarreau9787efa2015-03-28 19:17:31 +0100605static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200606{
607 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200608 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100609 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200610
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200611 strm->next_in = NULL;
612 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200613 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200614 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200615
616 ret = deflate(strm, flag);
617 if (ret != Z_OK && ret != Z_STREAM_END)
618 return -1;
619
Willy Tarreaueac52592018-06-15 13:59:36 +0200620 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200621 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200622
William Lallemand072a2bf2012-11-20 17:01:01 +0100623 /* compression limit */
624 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 +0200625 (ti->idle_pct < compress_min_idle)) { /* idle */
William Lallemand072a2bf2012-11-20 17:01:01 +0100626 /* decrease level */
627 if (comp_ctx->cur_lvl > 0) {
628 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100629 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
630 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100631
632 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
633 /* increase level */
634 comp_ctx->cur_lvl++ ;
635 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100636 }
637
William Lallemand82fe75c2012-10-23 10:25:10 +0200638 return out_len;
639}
640
Willy Tarreau9787efa2015-03-28 19:17:31 +0100641static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
642{
643 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
644}
645
646static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
647{
648 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
649}
650
Willy Tarreau9f640a12015-03-28 15:46:00 +0100651static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200652{
William Lallemand8b52bb32012-11-16 18:06:41 +0100653 z_stream *strm = &(*comp_ctx)->strm;
654 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200655
William Lallemand8b52bb32012-11-16 18:06:41 +0100656 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200657
William Lallemand8b52bb32012-11-16 18:06:41 +0100658 deinit_comp_ctx(comp_ctx);
659
660 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200661}
662
Willy Tarreau36878032016-12-22 19:46:17 +0100663/* config parser for global "tune.zlibmemlevel" */
664static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
665 struct proxy *defpx, const char *file, int line,
666 char **err)
667{
668 if (too_many_args(1, args, err, NULL))
669 return -1;
670
671 if (*(args[1]) == 0) {
672 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
673 return -1;
674 }
675
676 global_tune_zlibmemlevel = atoi(args[1]);
677 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
678 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
679 return -1;
680 }
681 return 0;
682}
683
684
685/* config parser for global "tune.zlibwindowsize" */
686static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
687 struct proxy *defpx, const char *file, int line,
688 char **err)
689{
690 if (too_many_args(1, args, err, NULL))
691 return -1;
692
693 if (*(args[1]) == 0) {
694 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
695 return -1;
696 }
697
698 global_tune_zlibwindowsize = atoi(args[1]);
699 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
700 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
701 return -1;
702 }
703 return 0;
704}
705
William Lallemand82fe75c2012-10-23 10:25:10 +0200706#endif /* USE_ZLIB */
707
Willy Tarreau36878032016-12-22 19:46:17 +0100708
709/* config keyword parsers */
710static struct cfg_kw_list cfg_kws = {ILH, {
711#ifdef USE_ZLIB
712 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
713 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
714#endif
715 { 0, NULL, NULL }
716}};
717
Willy Tarreau0108d902018-11-25 19:14:37 +0100718INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
719
William Lallemand727db8b2013-04-20 17:33:20 +0200720__attribute__((constructor))
721static void __comp_fetch_init(void)
722{
Willy Tarreau418b8c02015-03-29 03:32:06 +0200723#ifdef USE_SLZ
724 slz_make_crc_table();
725 slz_prepare_dist_table();
726#endif
Willy Tarreaue5489742018-11-26 14:44:03 +0100727
Willy Tarreau36878032016-12-22 19:46:17 +0100728#if defined(USE_ZLIB) && defined(DEFAULT_MAXZLIBMEM)
Willy Tarreau3bfcd102018-11-26 10:24:45 +0100729 global.maxzlibmem = DEFAULT_MAXZLIBMEM * 1024U * 1024U;
Willy Tarreau36878032016-12-22 19:46:17 +0100730#endif
Willy Tarreau80713382018-11-26 10:19:54 +0100731}
732
733static void comp_register_build_opts(void)
734{
735 char *ptr = NULL;
736 int i;
737
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100738#ifdef USE_ZLIB
739 memprintf(&ptr, "Built with zlib version : " ZLIB_VERSION);
740 memprintf(&ptr, "%s\nRunning on zlib version : %s", ptr, zlibVersion());
741#elif defined(USE_SLZ)
742 memprintf(&ptr, "Built with libslz for stateless compression.");
Lukas Tribusb7323212017-01-11 14:24:35 +0000743#else
744 memprintf(&ptr, "Built without compression support (neither USE_ZLIB nor USE_SLZ are set).");
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100745#endif
746 memprintf(&ptr, "%s\nCompression algorithms supported :", ptr);
747
748 for (i = 0; comp_algos[i].cfg_name; i++)
749 memprintf(&ptr, "%s%s %s(\"%s\")", ptr, (i == 0 ? "" : ","), comp_algos[i].cfg_name, comp_algos[i].ua_name);
750
751 if (i == 0)
752 memprintf(&ptr, "%s none", ptr);
753
754 hap_register_build_opts(ptr, 1);
William Lallemand727db8b2013-04-20 17:33:20 +0200755}
Willy Tarreau80713382018-11-26 10:19:54 +0100756
757INITCALL0(STG_REGISTER, comp_register_build_opts);