blob: 218a28486854639e90ea09f435d9bd4e11adadf5 [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 Tarreau36878032016-12-22 19:46:17 +010029#include <common/cfgparse.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020030#include <common/compat.h>
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +020031#include <common/hathreads.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010032#include <common/initcall.h>
33#include <common/memory.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020034
35#include <types/global.h>
36#include <types/compression.h>
37
William Lallemand727db8b2013-04-20 17:33:20 +020038#include <proto/acl.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020039#include <proto/compression.h>
William Lallemandd85f9172012-11-09 17:05:39 +010040#include <proto/freq_ctr.h>
Willy Tarreaue36cbcb2015-04-03 15:40:56 +020041#include <proto/stream.h>
William Lallemand82fe75c2012-10-23 10:25:10 +020042
William Lallemand2b502472012-10-30 14:30:39 +010043
Willy Tarreaue5489742018-11-26 14:44:03 +010044#if defined(USE_ZLIB)
Willy Tarreau86abe442018-11-25 20:12:18 +010045__decl_spinlock(comp_pool_lock);
Emeric Brun11f58862017-11-07 11:57:54 +010046#endif
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +020047
William Lallemand2b502472012-10-30 14:30:39 +010048#ifdef USE_ZLIB
49
William Lallemand8b52bb32012-11-16 18:06:41 +010050static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size);
51static void free_zlib(void *opaque, void *ptr);
52
William Lallemand2b502472012-10-30 14:30:39 +010053/* zlib allocation */
54static struct pool_head *zlib_pool_deflate_state = NULL;
55static struct pool_head *zlib_pool_window = NULL;
56static struct pool_head *zlib_pool_prev = NULL;
57static struct pool_head *zlib_pool_head = NULL;
58static struct pool_head *zlib_pool_pending_buf = NULL;
59
William Lallemande3a7d992012-11-20 11:25:20 +010060long zlib_used_memory = 0;
William Lallemand9d5f5482012-11-07 16:12:57 +010061
Willy Tarreau36878032016-12-22 19:46:17 +010062static int global_tune_zlibmemlevel = 8; /* zlib memlevel */
63static int global_tune_zlibwindowsize = MAX_WBITS; /* zlib window size */
64
William Lallemand2b502472012-10-30 14:30:39 +010065#endif
66
William Lallemand072a2bf2012-11-20 17:01:01 +010067unsigned int compress_min_idle = 0;
William Lallemand8b52bb32012-11-16 18:06:41 +010068
Willy Tarreau9f640a12015-03-28 15:46:00 +010069static int identity_init(struct comp_ctx **comp_ctx, int level);
70static int identity_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
Willy Tarreau9787efa2015-03-28 19:17:31 +010071static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out);
72static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010073static int identity_end(struct comp_ctx **comp_ctx);
74
Willy Tarreau418b8c02015-03-29 03:32:06 +020075#if defined(USE_SLZ)
76
77static int rfc1950_init(struct comp_ctx **comp_ctx, int level);
78static int rfc1951_init(struct comp_ctx **comp_ctx, int level);
79static int rfc1952_init(struct comp_ctx **comp_ctx, int level);
80static int rfc195x_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
81static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out);
82static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out);
83static int rfc195x_end(struct comp_ctx **comp_ctx);
84
85#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +010086
Willy Tarreau9f640a12015-03-28 15:46:00 +010087static int gzip_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreauc91840a2015-03-28 17:00:39 +010088static int raw_def_init(struct comp_ctx **comp_ctx, int level);
Willy Tarreau9f640a12015-03-28 15:46:00 +010089static int deflate_init(struct comp_ctx **comp_ctx, int level);
90static int deflate_add_data(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
Willy Tarreau9787efa2015-03-28 19:17:31 +010091static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out);
92static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out);
Willy Tarreau9f640a12015-03-28 15:46:00 +010093static int deflate_end(struct comp_ctx **comp_ctx);
Willy Tarreau7b218772015-03-28 22:08:25 +010094
Willy Tarreau9f640a12015-03-28 15:46:00 +010095#endif /* USE_ZLIB */
96
William Lallemand2b502472012-10-30 14:30:39 +010097
Cyril Bonté6162c432012-11-10 19:27:47 +010098const struct comp_algo comp_algos[] =
William Lallemand82fe75c2012-10-23 10:25:10 +020099{
Willy Tarreau7b218772015-03-28 22:08:25 +0100100 { "identity", 8, "identity", 8, identity_init, identity_add_data, identity_flush, identity_finish, identity_end },
Willy Tarreau418b8c02015-03-29 03:32:06 +0200101#if defined(USE_SLZ)
102 { "deflate", 7, "deflate", 7, rfc1950_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
103 { "raw-deflate", 11, "deflate", 7, rfc1951_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
104 { "gzip", 4, "gzip", 4, rfc1952_init, rfc195x_add_data, rfc195x_flush, rfc195x_finish, rfc195x_end },
105#elif defined(USE_ZLIB)
Willy Tarreau7b218772015-03-28 22:08:25 +0100106 { "deflate", 7, "deflate", 7, deflate_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
107 { "raw-deflate", 11, "deflate", 7, raw_def_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
108 { "gzip", 4, "gzip", 4, gzip_init, deflate_add_data, deflate_flush, deflate_finish, deflate_end },
William Lallemand82fe75c2012-10-23 10:25:10 +0200109#endif /* USE_ZLIB */
Willy Tarreau615105e2015-03-28 16:40:46 +0100110 { NULL, 0, NULL, 0, NULL , NULL, NULL, NULL, NULL }
William Lallemand82fe75c2012-10-23 10:25:10 +0200111};
112
113/*
114 * Add a content-type in the configuration
115 */
116int comp_append_type(struct comp *comp, const char *type)
117{
118 struct comp_type *comp_type;
119
Vincent Bernat02779b62016-04-03 13:48:43 +0200120 comp_type = calloc(1, sizeof(*comp_type));
William Lallemand82fe75c2012-10-23 10:25:10 +0200121 comp_type->name_len = strlen(type);
122 comp_type->name = strdup(type);
123 comp_type->next = comp->types;
124 comp->types = comp_type;
125 return 0;
126}
127
128/*
129 * Add an algorithm in the configuration
130 */
131int comp_append_algo(struct comp *comp, const char *algo)
132{
133 struct comp_algo *comp_algo;
134 int i;
135
Willy Tarreau615105e2015-03-28 16:40:46 +0100136 for (i = 0; comp_algos[i].cfg_name; i++) {
137 if (!strcmp(algo, comp_algos[i].cfg_name)) {
Vincent Bernat02779b62016-04-03 13:48:43 +0200138 comp_algo = calloc(1, sizeof(*comp_algo));
William Lallemand82fe75c2012-10-23 10:25:10 +0200139 memmove(comp_algo, &comp_algos[i], sizeof(struct comp_algo));
140 comp_algo->next = comp->algos;
141 comp->algos = comp_algo;
142 return 0;
143 }
144 }
145 return -1;
146}
147
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200148#if defined(USE_ZLIB) || defined(USE_SLZ)
149static struct pool_head *pool_comp_ctx = NULL;
William Lallemand8b52bb32012-11-16 18:06:41 +0100150/*
151 * Alloc the comp_ctx
152 */
153static inline int init_comp_ctx(struct comp_ctx **comp_ctx)
154{
155#ifdef USE_ZLIB
156 z_stream *strm;
157
William Lallemande3a7d992012-11-20 11:25:20 +0100158 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < sizeof(struct comp_ctx))
William Lallemand8b52bb32012-11-16 18:06:41 +0100159 return -1;
160#endif
161
Willy Tarreaubafbe012017-11-24 17:34:44 +0100162 *comp_ctx = pool_alloc(pool_comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100163 if (*comp_ctx == NULL)
164 return -1;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200165#if defined(USE_SLZ)
166 (*comp_ctx)->direct_ptr = NULL;
167 (*comp_ctx)->direct_len = 0;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200168 (*comp_ctx)->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200169#elif defined(USE_ZLIB)
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200170 HA_ATOMIC_ADD(&zlib_used_memory, sizeof(struct comp_ctx));
William Lallemand8b52bb32012-11-16 18:06:41 +0100171
172 strm = &(*comp_ctx)->strm;
173 strm->zalloc = alloc_zlib;
174 strm->zfree = free_zlib;
175 strm->opaque = *comp_ctx;
176#endif
177 return 0;
178}
179
180/*
181 * Dealloc the comp_ctx
182 */
183static inline int deinit_comp_ctx(struct comp_ctx **comp_ctx)
184{
185 if (!*comp_ctx)
186 return 0;
187
Willy Tarreaubafbe012017-11-24 17:34:44 +0100188 pool_free(pool_comp_ctx, *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +0100189 *comp_ctx = NULL;
190
191#ifdef USE_ZLIB
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200192 HA_ATOMIC_SUB(&zlib_used_memory, sizeof(struct comp_ctx));
William Lallemand8b52bb32012-11-16 18:06:41 +0100193#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100194 return 0;
195}
Willy Tarreaue1cc4b52016-08-10 21:17:06 +0200196#endif
William Lallemand8b52bb32012-11-16 18:06:41 +0100197
William Lallemand82fe75c2012-10-23 10:25:10 +0200198
199/****************************
200 **** Identity algorithm ****
201 ****************************/
202
203/*
204 * Init the identity algorithm
205 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100206static int identity_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200207{
208 return 0;
209}
210
211/*
212 * Process data
William Lallemandbf3ae612012-11-19 12:35:37 +0100213 * Return size of consumed data or -1 on error
William Lallemand82fe75c2012-10-23 10:25:10 +0200214 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100215static 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 +0200216{
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200217 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200218 int out_len = b_room(out);
William Lallemandbf3ae612012-11-19 12:35:37 +0100219
William Lallemand82fe75c2012-10-23 10:25:10 +0200220 if (out_len < in_len)
221 return -1;
222
223 memcpy(out_data, in_data, in_len);
224
Olivier Houchardacd14032018-06-28 18:17:23 +0200225 b_add(out, in_len);
William Lallemandbf3ae612012-11-19 12:35:37 +0100226
William Lallemand82fe75c2012-10-23 10:25:10 +0200227 return in_len;
228}
229
Willy Tarreau9787efa2015-03-28 19:17:31 +0100230static int identity_flush(struct comp_ctx *comp_ctx, struct buffer *out)
William Lallemand82fe75c2012-10-23 10:25:10 +0200231{
232 return 0;
233}
234
Willy Tarreau9787efa2015-03-28 19:17:31 +0100235static int identity_finish(struct comp_ctx *comp_ctx, struct buffer *out)
236{
237 return 0;
238}
239
Willy Tarreau418b8c02015-03-29 03:32:06 +0200240/*
241 * Deinit the algorithm
242 */
243static int identity_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200244{
245 return 0;
246}
247
Willy Tarreau418b8c02015-03-29 03:32:06 +0200248
249#ifdef USE_SLZ
250
251/* SLZ's gzip format (RFC1952). Returns < 0 on error. */
252static int rfc1952_init(struct comp_ctx **comp_ctx, int level)
253{
254 if (init_comp_ctx(comp_ctx) < 0)
255 return -1;
256
257 (*comp_ctx)->cur_lvl = !!level;
258 return slz_rfc1952_init(&(*comp_ctx)->strm, !!level);
259}
260
261/* SLZ's raw deflate format (RFC1951). Returns < 0 on error. */
262static int rfc1951_init(struct comp_ctx **comp_ctx, int level)
263{
264 if (init_comp_ctx(comp_ctx) < 0)
265 return -1;
266
267 (*comp_ctx)->cur_lvl = !!level;
268 return slz_rfc1951_init(&(*comp_ctx)->strm, !!level);
269}
270
271/* SLZ's zlib format (RFC1950). Returns < 0 on error. */
272static int rfc1950_init(struct comp_ctx **comp_ctx, int level)
273{
274 if (init_comp_ctx(comp_ctx) < 0)
275 return -1;
276
277 (*comp_ctx)->cur_lvl = !!level;
278 return slz_rfc1950_init(&(*comp_ctx)->strm, !!level);
279}
280
281/* Return the size of consumed data or -1. The output buffer is unused at this
282 * point, we only keep a reference to the input data or a copy of them if the
283 * reference is already used.
William Lallemand82fe75c2012-10-23 10:25:10 +0200284 */
Willy Tarreau418b8c02015-03-29 03:32:06 +0200285static 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 +0200286{
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200287 static THREAD_LOCAL struct buffer tmpbuf = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200288
289 if (in_len <= 0)
290 return 0;
291
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200292 if (comp_ctx->direct_ptr && b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200293 /* data already being pointed to, we're in front of fragmented
294 * data and need a buffer now. We reuse the same buffer, as it's
295 * not used out of the scope of a series of add_data()*, end().
296 */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200297 if (unlikely(!tmpbuf.size)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200298 /* this is the first time we need the compression buffer */
299 if (b_alloc(&tmpbuf) == NULL)
300 return -1; /* no memory */
301 }
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200302 b_reset(&tmpbuf);
303 memcpy(b_tail(&tmpbuf), comp_ctx->direct_ptr, comp_ctx->direct_len);
304 b_add(&tmpbuf, comp_ctx->direct_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200305 comp_ctx->direct_ptr = NULL;
306 comp_ctx->direct_len = 0;
307 comp_ctx->queued = tmpbuf;
308 /* fall through buffer copy */
309 }
310
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200311 if (!b_is_null(&comp_ctx->queued)) {
Willy Tarreau418b8c02015-03-29 03:32:06 +0200312 /* data already pending */
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200313 memcpy(b_tail(&comp_ctx->queued), in_data, in_len);
314 b_add(&comp_ctx->queued, in_len);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200315 return in_len;
316 }
317
318 comp_ctx->direct_ptr = in_data;
319 comp_ctx->direct_len = in_len;
320 return in_len;
321}
322
323/* Compresses the data accumulated using add_data(), and optionally sends the
324 * format-specific trailer if <finish> is non-null. <out> is expected to have a
325 * large enough free non-wrapping space as verified by http_comp_buffer_init().
326 * The number of bytes emitted is reported.
327 */
328static int rfc195x_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int finish)
329{
330 struct slz_stream *strm = &comp_ctx->strm;
331 const char *in_ptr;
332 int in_len;
333 int out_len;
334
335 in_ptr = comp_ctx->direct_ptr;
336 in_len = comp_ctx->direct_len;
337
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200338 if (!b_is_null(&comp_ctx->queued)) {
339 in_ptr = b_head(&comp_ctx->queued);
340 in_len = b_data(&comp_ctx->queued);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200341 }
342
Olivier Houchard0b662842018-06-29 18:16:31 +0200343 out_len = b_data(out);
Willy Tarreau418b8c02015-03-29 03:32:06 +0200344
345 if (in_ptr)
Olivier Houchardacd14032018-06-28 18:17:23 +0200346 b_add(out, slz_encode(strm, b_tail(out), in_ptr, in_len, !finish));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200347
348 if (finish)
Olivier Houchardacd14032018-06-28 18:17:23 +0200349 b_add(out, slz_finish(strm, b_tail(out)));
Willy Tarreau418b8c02015-03-29 03:32:06 +0200350
Olivier Houchard0b662842018-06-29 18:16:31 +0200351 out_len = b_data(out) - out_len;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200352
353 /* very important, we must wipe the data we've just flushed */
354 comp_ctx->direct_len = 0;
355 comp_ctx->direct_ptr = NULL;
Willy Tarreauc9fa0482018-07-10 17:43:27 +0200356 comp_ctx->queued = BUF_NULL;
Willy Tarreau418b8c02015-03-29 03:32:06 +0200357
358 /* Verify compression rate limiting and CPU usage */
359 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
360 (idle_pct < compress_min_idle)) { /* idle */
361 if (comp_ctx->cur_lvl > 0)
362 strm->level = --comp_ctx->cur_lvl;
363 }
364 else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel && comp_ctx->cur_lvl < 1) {
365 strm->level = ++comp_ctx->cur_lvl;
366 }
367
368 /* and that's all */
369 return out_len;
370}
371
372static int rfc195x_flush(struct comp_ctx *comp_ctx, struct buffer *out)
373{
374 return rfc195x_flush_or_finish(comp_ctx, out, 0);
375}
376
377static int rfc195x_finish(struct comp_ctx *comp_ctx, struct buffer *out)
378{
379 return rfc195x_flush_or_finish(comp_ctx, out, 1);
380}
381
382/* we just need to free the comp_ctx here, nothing was allocated */
383static int rfc195x_end(struct comp_ctx **comp_ctx)
384{
385 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200386 return 0;
387}
388
Willy Tarreau418b8c02015-03-29 03:32:06 +0200389#elif defined(USE_ZLIB) /* ! USE_SLZ */
William Lallemand82fe75c2012-10-23 10:25:10 +0200390
William Lallemand2b502472012-10-30 14:30:39 +0100391/*
392 * This is a tricky allocation function using the zlib.
393 * This is based on the allocation order in deflateInit2.
394 */
395static void *alloc_zlib(void *opaque, unsigned int items, unsigned int size)
396{
397 struct comp_ctx *ctx = opaque;
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200398 static THREAD_LOCAL char round = 0; /* order in deflateInit2 */
William Lallemand2b502472012-10-30 14:30:39 +0100399 void *buf = NULL;
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100400 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100401
William Lallemande3a7d992012-11-20 11:25:20 +0100402 if (global.maxzlibmem > 0 && (global.maxzlibmem - zlib_used_memory) < (long)(items * size))
William Lallemand9d5f5482012-11-07 16:12:57 +0100403 goto end;
William Lallemand9d5f5482012-11-07 16:12:57 +0100404
William Lallemand2b502472012-10-30 14:30:39 +0100405 switch (round) {
406 case 0:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200407 if (zlib_pool_deflate_state == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100408 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200409 if (zlib_pool_deflate_state == NULL)
410 zlib_pool_deflate_state = create_pool("zlib_state", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100411 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200412 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100413 pool = zlib_pool_deflate_state;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100414 ctx->zlib_deflate_state = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100415 break;
416
417 case 1:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200418 if (zlib_pool_window == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100419 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200420 if (zlib_pool_window == NULL)
421 zlib_pool_window = create_pool("zlib_window", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100422 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200423 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100424 pool = zlib_pool_window;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100425 ctx->zlib_window = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100426 break;
427
428 case 2:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200429 if (zlib_pool_prev == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100430 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200431 if (zlib_pool_prev == NULL)
432 zlib_pool_prev = create_pool("zlib_prev", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100433 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200434 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100435 pool = zlib_pool_prev;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100436 ctx->zlib_prev = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100437 break;
438
439 case 3:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200440 if (zlib_pool_head == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100441 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200442 if (zlib_pool_head == NULL)
443 zlib_pool_head = create_pool("zlib_head", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100444 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200445 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100446 pool = zlib_pool_head;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100447 ctx->zlib_head = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100448 break;
449
450 case 4:
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200451 if (zlib_pool_pending_buf == NULL) {
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100452 HA_SPIN_LOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200453 if (zlib_pool_pending_buf == NULL)
454 zlib_pool_pending_buf = create_pool("zlib_pending_buf", size * items, MEM_F_SHARED);
Christopher Faulet2a944ee2017-11-07 10:42:54 +0100455 HA_SPIN_UNLOCK(COMP_POOL_LOCK, &comp_pool_lock);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200456 }
Willy Tarreau4f31fc22014-12-24 18:07:55 +0100457 pool = zlib_pool_pending_buf;
Willy Tarreaubafbe012017-11-24 17:34:44 +0100458 ctx->zlib_pending_buf = buf = pool_alloc(pool);
William Lallemand2b502472012-10-30 14:30:39 +0100459 break;
460 }
William Lallemande3a7d992012-11-20 11:25:20 +0100461 if (buf != NULL)
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200462 HA_ATOMIC_ADD(&zlib_used_memory, pool->size);
William Lallemand9d5f5482012-11-07 16:12:57 +0100463
464end:
William Lallemand2b502472012-10-30 14:30:39 +0100465
Willy Tarreau46909852012-11-15 14:57:56 +0100466 /* deflateInit2() first allocates and checks the deflate_state, then if
467 * it succeeds, it allocates all other 4 areas at ones and checks them
468 * at the end. So we want to correctly count the rounds depending on when
469 * zlib is supposed to abort.
470 */
471 if (buf || round)
472 round = (round + 1) % 5;
William Lallemand2b502472012-10-30 14:30:39 +0100473 return buf;
474}
475
476static void free_zlib(void *opaque, void *ptr)
477{
478 struct comp_ctx *ctx = opaque;
Willy Tarreaub1fbd052012-11-10 17:49:37 +0100479 struct pool_head *pool = NULL;
William Lallemand2b502472012-10-30 14:30:39 +0100480
481 if (ptr == ctx->zlib_window)
William Lallemand9d5f5482012-11-07 16:12:57 +0100482 pool = zlib_pool_window;
William Lallemand2b502472012-10-30 14:30:39 +0100483 else if (ptr == ctx->zlib_deflate_state)
William Lallemand9d5f5482012-11-07 16:12:57 +0100484 pool = zlib_pool_deflate_state;
William Lallemand2b502472012-10-30 14:30:39 +0100485 else if (ptr == ctx->zlib_prev)
William Lallemand9d5f5482012-11-07 16:12:57 +0100486 pool = zlib_pool_prev;
William Lallemand2b502472012-10-30 14:30:39 +0100487 else if (ptr == ctx->zlib_head)
William Lallemand9d5f5482012-11-07 16:12:57 +0100488 pool = zlib_pool_head;
William Lallemand2b502472012-10-30 14:30:39 +0100489 else if (ptr == ctx->zlib_pending_buf)
William Lallemand9d5f5482012-11-07 16:12:57 +0100490 pool = zlib_pool_pending_buf;
William Lallemand2b502472012-10-30 14:30:39 +0100491
Willy Tarreaubafbe012017-11-24 17:34:44 +0100492 pool_free(pool, ptr);
Christopher Faulet8ca3b4b2017-07-25 11:07:15 +0200493 HA_ATOMIC_SUB(&zlib_used_memory, pool->size);
William Lallemand2b502472012-10-30 14:30:39 +0100494}
495
William Lallemand82fe75c2012-10-23 10:25:10 +0200496/**************************
497**** gzip algorithm ****
498***************************/
Willy Tarreau9f640a12015-03-28 15:46:00 +0100499static int gzip_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200500{
William Lallemand8b52bb32012-11-16 18:06:41 +0100501 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200502
William Lallemand8b52bb32012-11-16 18:06:41 +0100503 if (init_comp_ctx(comp_ctx) < 0)
504 return -1;
William Lallemand9d5f5482012-11-07 16:12:57 +0100505
William Lallemand8b52bb32012-11-16 18:06:41 +0100506 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200507
Willy Tarreau36878032016-12-22 19:46:17 +0100508 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 +0100509 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200510 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100511 }
512
513 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200514
515 return 0;
516}
Willy Tarreauc91840a2015-03-28 17:00:39 +0100517
518/* Raw deflate algorithm */
519static int raw_def_init(struct comp_ctx **comp_ctx, int level)
520{
521 z_stream *strm;
522
523 if (init_comp_ctx(comp_ctx) < 0)
524 return -1;
525
526 strm = &(*comp_ctx)->strm;
527
Willy Tarreau36878032016-12-22 19:46:17 +0100528 if (deflateInit2(strm, level, Z_DEFLATED, -global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
Willy Tarreauc91840a2015-03-28 17:00:39 +0100529 deinit_comp_ctx(comp_ctx);
530 return -1;
531 }
532
533 (*comp_ctx)->cur_lvl = level;
534 return 0;
535}
536
William Lallemand82fe75c2012-10-23 10:25:10 +0200537/**************************
538**** Deflate algorithm ****
539***************************/
540
Willy Tarreau9f640a12015-03-28 15:46:00 +0100541static int deflate_init(struct comp_ctx **comp_ctx, int level)
William Lallemand82fe75c2012-10-23 10:25:10 +0200542{
William Lallemand8b52bb32012-11-16 18:06:41 +0100543 z_stream *strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200544
William Lallemand8b52bb32012-11-16 18:06:41 +0100545 if (init_comp_ctx(comp_ctx) < 0)
546 return -1;
547
548 strm = &(*comp_ctx)->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200549
Willy Tarreau36878032016-12-22 19:46:17 +0100550 if (deflateInit2(strm, level, Z_DEFLATED, global_tune_zlibwindowsize, global_tune_zlibmemlevel, Z_DEFAULT_STRATEGY) != Z_OK) {
William Lallemand8b52bb32012-11-16 18:06:41 +0100551 deinit_comp_ctx(comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +0200552 return -1;
William Lallemand8b52bb32012-11-16 18:06:41 +0100553 }
554
555 (*comp_ctx)->cur_lvl = level;
William Lallemand82fe75c2012-10-23 10:25:10 +0200556
557 return 0;
558}
559
William Lallemandbf3ae612012-11-19 12:35:37 +0100560/* Return the size of consumed data or -1 */
Willy Tarreau9f640a12015-03-28 15:46:00 +0100561static 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 +0200562{
William Lallemand82fe75c2012-10-23 10:25:10 +0200563 int ret;
William Lallemandbf3ae612012-11-19 12:35:37 +0100564 z_stream *strm = &comp_ctx->strm;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200565 char *out_data = b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200566 int out_len = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200567
568 if (in_len <= 0)
569 return 0;
570
571
572 if (out_len <= 0)
573 return -1;
574
William Lallemand82fe75c2012-10-23 10:25:10 +0200575 strm->next_in = (unsigned char *)in_data;
576 strm->avail_in = in_len;
577 strm->next_out = (unsigned char *)out_data;
578 strm->avail_out = out_len;
579
580 ret = deflate(strm, Z_NO_FLUSH);
581 if (ret != Z_OK)
582 return -1;
583
584 /* deflate update the available data out */
Olivier Houchardacd14032018-06-28 18:17:23 +0200585 b_add(out, out_len - strm->avail_out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200586
William Lallemandbf3ae612012-11-19 12:35:37 +0100587 return in_len - strm->avail_in;
William Lallemand82fe75c2012-10-23 10:25:10 +0200588}
589
Willy Tarreau9787efa2015-03-28 19:17:31 +0100590static int deflate_flush_or_finish(struct comp_ctx *comp_ctx, struct buffer *out, int flag)
William Lallemand82fe75c2012-10-23 10:25:10 +0200591{
592 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200593 int out_len = 0;
William Lallemand1c2d6222012-10-30 15:52:53 +0100594 z_stream *strm = &comp_ctx->strm;
William Lallemand82fe75c2012-10-23 10:25:10 +0200595
Willy Tarreaud8b8b532016-08-08 16:41:01 +0200596 strm->next_in = NULL;
597 strm->avail_in = 0;
Willy Tarreau8f9c72d2018-06-07 18:46:28 +0200598 strm->next_out = (unsigned char *)b_tail(out);
Willy Tarreaueac52592018-06-15 13:59:36 +0200599 strm->avail_out = b_room(out);
William Lallemand82fe75c2012-10-23 10:25:10 +0200600
601 ret = deflate(strm, flag);
602 if (ret != Z_OK && ret != Z_STREAM_END)
603 return -1;
604
Willy Tarreaueac52592018-06-15 13:59:36 +0200605 out_len = b_room(out) - strm->avail_out;
Olivier Houchardacd14032018-06-28 18:17:23 +0200606 b_add(out, out_len);
William Lallemand82fe75c2012-10-23 10:25:10 +0200607
William Lallemand072a2bf2012-11-20 17:01:01 +0100608 /* compression limit */
609 if ((global.comp_rate_lim > 0 && (read_freq_ctr(&global.comp_bps_out) > global.comp_rate_lim)) || /* rate */
610 (idle_pct < compress_min_idle)) { /* idle */
611 /* decrease level */
612 if (comp_ctx->cur_lvl > 0) {
613 comp_ctx->cur_lvl--;
William Lallemandd85f9172012-11-09 17:05:39 +0100614 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
615 }
William Lallemand072a2bf2012-11-20 17:01:01 +0100616
617 } else if (comp_ctx->cur_lvl < global.tune.comp_maxlevel) {
618 /* increase level */
619 comp_ctx->cur_lvl++ ;
620 deflateParams(&comp_ctx->strm, comp_ctx->cur_lvl, Z_DEFAULT_STRATEGY);
William Lallemandd85f9172012-11-09 17:05:39 +0100621 }
622
William Lallemand82fe75c2012-10-23 10:25:10 +0200623 return out_len;
624}
625
Willy Tarreau9787efa2015-03-28 19:17:31 +0100626static int deflate_flush(struct comp_ctx *comp_ctx, struct buffer *out)
627{
628 return deflate_flush_or_finish(comp_ctx, out, Z_SYNC_FLUSH);
629}
630
631static int deflate_finish(struct comp_ctx *comp_ctx, struct buffer *out)
632{
633 return deflate_flush_or_finish(comp_ctx, out, Z_FINISH);
634}
635
Willy Tarreau9f640a12015-03-28 15:46:00 +0100636static int deflate_end(struct comp_ctx **comp_ctx)
William Lallemand82fe75c2012-10-23 10:25:10 +0200637{
William Lallemand8b52bb32012-11-16 18:06:41 +0100638 z_stream *strm = &(*comp_ctx)->strm;
639 int ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200640
William Lallemand8b52bb32012-11-16 18:06:41 +0100641 ret = deflateEnd(strm);
William Lallemand82fe75c2012-10-23 10:25:10 +0200642
William Lallemand8b52bb32012-11-16 18:06:41 +0100643 deinit_comp_ctx(comp_ctx);
644
645 return ret;
William Lallemand82fe75c2012-10-23 10:25:10 +0200646}
647
Willy Tarreau36878032016-12-22 19:46:17 +0100648/* config parser for global "tune.zlibmemlevel" */
649static int zlib_parse_global_memlevel(char **args, int section_type, struct proxy *curpx,
650 struct proxy *defpx, const char *file, int line,
651 char **err)
652{
653 if (too_many_args(1, args, err, NULL))
654 return -1;
655
656 if (*(args[1]) == 0) {
657 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
658 return -1;
659 }
660
661 global_tune_zlibmemlevel = atoi(args[1]);
662 if (global_tune_zlibmemlevel < 1 || global_tune_zlibmemlevel > 9) {
663 memprintf(err, "'%s' expects a numeric value between 1 and 9.", args[0]);
664 return -1;
665 }
666 return 0;
667}
668
669
670/* config parser for global "tune.zlibwindowsize" */
671static int zlib_parse_global_windowsize(char **args, int section_type, struct proxy *curpx,
672 struct proxy *defpx, const char *file, int line,
673 char **err)
674{
675 if (too_many_args(1, args, err, NULL))
676 return -1;
677
678 if (*(args[1]) == 0) {
679 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
680 return -1;
681 }
682
683 global_tune_zlibwindowsize = atoi(args[1]);
684 if (global_tune_zlibwindowsize < 8 || global_tune_zlibwindowsize > 15) {
685 memprintf(err, "'%s' expects a numeric value between 8 and 15.", args[0]);
686 return -1;
687 }
688 return 0;
689}
690
William Lallemand82fe75c2012-10-23 10:25:10 +0200691#endif /* USE_ZLIB */
692
Willy Tarreau36878032016-12-22 19:46:17 +0100693
694/* config keyword parsers */
695static struct cfg_kw_list cfg_kws = {ILH, {
696#ifdef USE_ZLIB
697 { CFG_GLOBAL, "tune.zlib.memlevel", zlib_parse_global_memlevel },
698 { CFG_GLOBAL, "tune.zlib.windowsize", zlib_parse_global_windowsize },
699#endif
700 { 0, NULL, NULL }
701}};
702
Willy Tarreau0108d902018-11-25 19:14:37 +0100703INITCALL1(STG_REGISTER, cfg_register_keywords, &cfg_kws);
704
William Lallemand727db8b2013-04-20 17:33:20 +0200705__attribute__((constructor))
706static void __comp_fetch_init(void)
707{
Willy Tarreau418b8c02015-03-29 03:32:06 +0200708#ifdef USE_SLZ
709 slz_make_crc_table();
710 slz_prepare_dist_table();
711#endif
Willy Tarreaue5489742018-11-26 14:44:03 +0100712
713#if defined(USE_ZLIB) || defined(USE_SLZ)
714 pool_comp_ctx = create_pool("comp_ctx", sizeof(struct comp_ctx), MEM_F_SHARED);
715#endif
716
Willy Tarreau36878032016-12-22 19:46:17 +0100717#if defined(USE_ZLIB) && defined(DEFAULT_MAXZLIBMEM)
Willy Tarreau3bfcd102018-11-26 10:24:45 +0100718 global.maxzlibmem = DEFAULT_MAXZLIBMEM * 1024U * 1024U;
Willy Tarreau36878032016-12-22 19:46:17 +0100719#endif
Willy Tarreau80713382018-11-26 10:19:54 +0100720}
721
722static void comp_register_build_opts(void)
723{
724 char *ptr = NULL;
725 int i;
726
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100727#ifdef USE_ZLIB
728 memprintf(&ptr, "Built with zlib version : " ZLIB_VERSION);
729 memprintf(&ptr, "%s\nRunning on zlib version : %s", ptr, zlibVersion());
730#elif defined(USE_SLZ)
731 memprintf(&ptr, "Built with libslz for stateless compression.");
Lukas Tribusb7323212017-01-11 14:24:35 +0000732#else
733 memprintf(&ptr, "Built without compression support (neither USE_ZLIB nor USE_SLZ are set).");
Willy Tarreaub97c6fb2016-12-21 19:30:30 +0100734#endif
735 memprintf(&ptr, "%s\nCompression algorithms supported :", ptr);
736
737 for (i = 0; comp_algos[i].cfg_name; i++)
738 memprintf(&ptr, "%s%s %s(\"%s\")", ptr, (i == 0 ? "" : ","), comp_algos[i].cfg_name, comp_algos[i].ua_name);
739
740 if (i == 0)
741 memprintf(&ptr, "%s none", ptr);
742
743 hap_register_build_opts(ptr, 1);
William Lallemand727db8b2013-04-20 17:33:20 +0200744}
Willy Tarreau80713382018-11-26 10:19:54 +0100745
746INITCALL0(STG_REGISTER, comp_register_build_opts);