blob: 376eea9ef8923817b692ab609b7e2d26fb3762da [file] [log] [blame]
William Lallemand82fe75c2012-10-23 10:25:10 +02001/*
2 * include/types/compression.h
3 * This file defines everything related to compression.
4 *
5 * Copyright 2012 Exceliance, David Du Colombier <dducolombier@exceliance.fr>
6 William Lallemand <wlallemand@exceliance.fr>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation, version 2.1
11 * exclusively.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23#ifndef _TYPES_COMP_H
24#define _TYPES_COMP_H
25
William Lallemand08289f12012-10-31 11:19:18 +010026#ifdef USE_ZLIB
27
William Lallemand82fe75c2012-10-23 10:25:10 +020028#include <zlib.h>
29
William Lallemand08289f12012-10-31 11:19:18 +010030#endif /* USE_ZLIB */
31
William Lallemand82fe75c2012-10-23 10:25:10 +020032struct comp {
33 struct comp_algo *algos;
34 struct comp_type *types;
Willy Tarreau70737d12012-10-27 00:34:28 +020035 unsigned int offload;
William Lallemand82fe75c2012-10-23 10:25:10 +020036};
37
William Lallemand1c2d6222012-10-30 15:52:53 +010038struct comp_ctx {
William Lallemand08289f12012-10-31 11:19:18 +010039#ifdef USE_ZLIB
William Lallemand1c2d6222012-10-30 15:52:53 +010040 z_stream strm; /* zlib stream */
William Lallemand2b502472012-10-30 14:30:39 +010041 void *zlib_deflate_state;
42 void *zlib_window;
43 void *zlib_prev;
44 void *zlib_pending_buf;
45 void *zlib_head;
William Lallemand08289f12012-10-31 11:19:18 +010046#endif /* USE_ZLIB */
William Lallemandf3747832012-11-09 12:33:10 +010047 int cur_lvl;
William Lallemand1c2d6222012-10-30 15:52:53 +010048};
49
Willy Tarreau615105e2015-03-28 16:40:46 +010050/* Thanks to MSIE/IIS, the "deflate" name is ambigous, as according to the RFC
51 * it's a zlib-wrapped deflate stream, but MSIE only understands a raw deflate
52 * stream. For this reason some people prefer to emit a raw deflate stream on
53 * "deflate" and we'll need two algos for the same name, they are distinguished
54 * with the config name.
55 */
William Lallemand82fe75c2012-10-23 10:25:10 +020056struct comp_algo {
Willy Tarreau615105e2015-03-28 16:40:46 +010057 char *cfg_name; /* config name */
58 int cfg_name_len;
59
60 char *ua_name; /* name for the user-agent */
61 int ua_name_len;
62
William Lallemand8b52bb32012-11-16 18:06:41 +010063 int (*init)(struct comp_ctx **comp_ctx, int level);
William Lallemandbf3ae612012-11-19 12:35:37 +010064 int (*add_data)(struct comp_ctx *comp_ctx, const char *in_data, int in_len, struct buffer *out);
Willy Tarreau9787efa2015-03-28 19:17:31 +010065 int (*flush)(struct comp_ctx *comp_ctx, struct buffer *out);
66 int (*finish)(struct comp_ctx *comp_ctx, struct buffer *out);
William Lallemand1c2d6222012-10-30 15:52:53 +010067 int (*reset)(struct comp_ctx *comp_ctx);
William Lallemand8b52bb32012-11-16 18:06:41 +010068 int (*end)(struct comp_ctx **comp_ctx);
William Lallemand82fe75c2012-10-23 10:25:10 +020069 struct comp_algo *next;
70};
71
William Lallemand82fe75c2012-10-23 10:25:10 +020072struct comp_type {
73 char *name;
74 int name_len;
75 struct comp_type *next;
76};
77
78
79#endif /* _TYPES_COMP_H */
80
81/*
82 * Local variables:
83 * c-indent-level: 8
84 * c-basic-offset: 8
85 * End:
86 */
87