varnish-cache/bin/varnishd/cache/cache_gzip.c
0
/*-
1
 * Copyright (c) 2013-2015 Varnish Software AS
2
 * All rights reserved.
3
 *
4
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
5
 *
6
 * SPDX-License-Identifier: BSD-2-Clause
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions
10
 * are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 * SUCH DAMAGE.
28
 *
29
 * Interaction with the libvgz (zlib) library.
30
 *
31
 * The zlib library pollutes namespace a LOT when you include the "vgz.h"
32
 * (aka "zlib.h") file so we contain the damage by vectoring all access
33
 * to libz through this source file.
34
 *
35
 * The API defined by this file, will also insulate the rest of the code,
36
 * should we find a better gzip library at a later date.
37
 *
38
 */
39
40
#include "config.h"
41
42
#include <stdlib.h>
43
44
#include "cache_varnishd.h"
45
#include "cache_filter.h"
46
#include "cache_objhead.h"
47
#include "cache_vgz.h"
48
#include "vend.h"
49
50
#include "vgz.h"
51
52
struct vgz {
53
        unsigned                magic;
54
#define VGZ_MAGIC               0x162df0cb
55
        enum {VGZ_GZ,VGZ_UN}    dir;
56
        struct vsl_log          *vsl;
57
        const char              *id;
58
        int                     last_i;
59
        enum vgz_flag           flag;
60
61
        char                    *m_buf;
62
        ssize_t                 m_sz;
63
        ssize_t                 m_len;
64
65
        intmax_t                bits;
66
67
        z_stream                vz;
68
};
69
70
static const char *
71 24
vgz_msg(const struct vgz *vg)
72
{
73 24
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
74 24
        return (vg->vz.msg ? vg->vz.msg : "(null)");
75
}
76
77
/*--------------------------------------------------------------------
78
 * Set up a gunzip instance
79
 */
80
81
static struct vgz *
82 924
vgz_gunzip(struct vsl_log *vsl, const char *id)
83
{
84
        struct vgz *vg;
85
86 924
        ALLOC_OBJ(vg, VGZ_MAGIC);
87 924
        AN(vg);
88 924
        vg->vsl = vsl;
89 924
        vg->id = id;
90 924
        vg->dir = VGZ_UN;
91
92
        /*
93
         * Max memory usage according to zonf.h:
94
         *      mem_needed = "a few kb" + (1 << (windowBits))
95
         * Since we don't control windowBits, we have to assume
96
         * it is 15, so 34-35KB or so.
97
         */
98 924
        assert(Z_OK == inflateInit2(&vg->vz, 31));
99 924
        return (vg);
100
}
101
102
static struct vgz *
103 804
VGZ_NewGunzip(struct vsl_log *vsl, const char *id)
104
{
105 804
        VSC_C_main->n_gunzip++;
106 804
        return (vgz_gunzip(vsl, id));
107
}
108
109
static struct vgz *
110 120
VGZ_NewTestGunzip(struct vsl_log *vsl, const char *id)
111
{
112 120
        VSC_C_main->n_test_gunzip++;
113 120
        return (vgz_gunzip(vsl, id));
114
}
115
116
struct vgz *
117 368
VGZ_NewGzip(struct vsl_log *vsl, const char *id)
118
{
119
        struct vgz *vg;
120
        int i;
121
122 368
        VSC_C_main->n_gzip++;
123 368
        ALLOC_OBJ(vg, VGZ_MAGIC);
124 368
        AN(vg);
125 368
        vg->vsl = vsl;
126 368
        vg->id = id;
127 368
        vg->dir = VGZ_GZ;
128
129
        /*
130
         * From zconf.h:
131
         *
132
         *      mem_needed = "a few kb"
133
         *              + (1 << (windowBits+2))
134
         *              +  (1 << (memLevel+9))
135
         *
136
         * windowBits [8..15] (-> 1K..128K)
137
         * memLevel [1..9] (-> 1K->256K)
138
         */
139 368
        i = deflateInit2(&vg->vz,
140
            cache_param->gzip_level,            /* Level */
141
            Z_DEFLATED,                         /* Method */
142
            16 + 15,                            /* Window bits (16=gzip) */
143
            cache_param->gzip_memlevel,         /* memLevel */
144
            Z_DEFAULT_STRATEGY);
145 368
        assert(Z_OK == i);
146 368
        return (vg);
147
}
148
149
/*--------------------------------------------------------------------
150
 */
151
152
static int
153 988
vgz_getmbuf(struct vgz *vg)
154
{
155
156 988
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
157 988
        AZ(vg->m_sz);
158 988
        AZ(vg->m_len);
159 988
        AZ(vg->m_buf);
160
161 988
        vg->m_sz = cache_param->gzip_buffer;
162 988
        vg->m_buf = malloc(vg->m_sz);
163 988
        if (vg->m_buf == NULL) {
164 0
                vg->m_sz = 0;
165 0
                return (-1);
166
        }
167 988
        return (0);
168 988
}
169
170
/*--------------------------------------------------------------------*/
171
172
void
173 6664
VGZ_Ibuf(struct vgz *vg, const void *ptr, ssize_t len)
174
{
175
176 6664
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
177
178 6664
        AZ(vg->vz.avail_in);
179 6664
        vg->vz.next_in = TRUST_ME(ptr);
180 6664
        vg->vz.avail_in = len;
181 6664
}
182
183
int
184 14950
VGZ_IbufEmpty(const struct vgz *vg)
185
{
186
187 14950
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
188 14950
        return (vg->vz.avail_in == 0);
189
}
190
191
/*--------------------------------------------------------------------*/
192
193
void
194 7037
VGZ_Obuf(struct vgz *vg, void *ptr, ssize_t len)
195
{
196
197 7037
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
198
199 7037
        vg->vz.next_out = TRUST_ME(ptr);
200 7037
        vg->vz.avail_out = len;
201 7037
}
202
203
int
204 4244
VGZ_ObufFull(const struct vgz *vg)
205
{
206
207 4244
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
208 4244
        return (vg->vz.avail_out == 0);
209
}
210
211
/*--------------------------------------------------------------------*/
212
213
static enum vgzret_e
214 3241
VGZ_Gunzip(struct vgz *vg, const void **pptr, ssize_t *plen)
215
{
216
        int i;
217
        ssize_t l;
218
        const uint8_t *before;
219
220 3241
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
221
222 3241
        *pptr = NULL;
223 3241
        *plen = 0;
224 3241
        AN(vg->vz.next_out);
225 3241
        AN(vg->vz.avail_out);
226 3241
        before = vg->vz.next_out;
227 3241
        i = inflate(&vg->vz, 0);
228 3241
        if (i == Z_OK || i == Z_STREAM_END) {
229 3225
                *pptr = before;
230 3225
                l = (const uint8_t *)vg->vz.next_out - before;
231 3225
                *plen = l;
232 3225
        }
233 3241
        vg->last_i = i;
234 3241
        if (i == Z_OK)
235 2233
                return (VGZ_OK);
236 1008
        if (i == Z_STREAM_END)
237 992
                return (VGZ_END);
238 16
        if (i == Z_BUF_ERROR)
239 8
                return (VGZ_STUCK);
240 8
        VSLb(vg->vsl, SLT_Gzip, "Gunzip error: %d (%s)", i, vgz_msg(vg));
241 8
        return (VGZ_ERROR);
242 3241
}
243
244
/*--------------------------------------------------------------------*/
245
246
enum vgzret_e
247 4512
VGZ_Gzip(struct vgz *vg, const void **pptr, ssize_t *plen, enum vgz_flag flags)
248
{
249
        int i;
250
        int zflg;
251
        ssize_t l;
252
        const uint8_t *before;
253
254 4512
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
255
256 4512
        *pptr = NULL;
257 4512
        *plen = 0;
258 4512
        AN(vg->vz.next_out);
259 4512
        AN(vg->vz.avail_out);
260 4512
        before = vg->vz.next_out;
261 4512
        switch (flags) {
262 2960
        case VGZ_NORMAL:        zflg = Z_NO_FLUSH; break;
263 500
        case VGZ_ALIGN:         zflg = Z_SYNC_FLUSH; break;
264 504
        case VGZ_RESET:         zflg = Z_FULL_FLUSH; break;
265 548
        case VGZ_FINISH:        zflg = Z_FINISH; break;
266 0
        default:                WRONG("Invalid VGZ flag");
267 0
        }
268 4512
        i = deflate(&vg->vz, zflg);
269 4512
        if (i == Z_OK || i == Z_STREAM_END) {
270 4512
                *pptr = before;
271 4512
                l = (const uint8_t *)vg->vz.next_out - before;
272 4512
                *plen = l;
273 4512
        }
274 4512
        vg->last_i = i;
275 4512
        if (i == Z_OK)
276 4164
                return (VGZ_OK);
277 348
        if (i == Z_STREAM_END)
278 348
                return (VGZ_END);
279 0
        if (i == Z_BUF_ERROR)
280 0
                return (VGZ_STUCK);
281 0
        VSLb(vg->vsl, SLT_Gzip, "Gzip error: %d (%s)", i, vgz_msg(vg));
282 0
        return (VGZ_ERROR);
283 4512
}
284
285
/*--------------------------------------------------------------------
286
 * VDP for gunzip'ing
287
 */
288
289
static int v_matchproto_(vdp_init_f)
290 304
vdp_gunzip_init(VRT_CTX, struct vdp_ctx *vdc, void **priv)
291
{
292
        struct vgz *vg;
293
        struct boc *boc;
294
        enum boc_state_e bos;
295
        const char *p;
296
        ssize_t dl;
297
        uint64_t u;
298
299 304
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
300 304
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
301 304
        CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
302 304
        CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
303 304
        AN(vdc->clen);
304 304
        AN(priv);
305
306 304
        vg = VGZ_NewGunzip(vdc->vsl, "U D -");
307 304
        AN(vg);
308 304
        if (vgz_getmbuf(vg)) {
309 0
                (void)VGZ_Destroy(&vg);
310 0
                return (-1);
311
        }
312
313 304
        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
314 304
        *priv = vg;
315
316 304
        http_Unset(vdc->hp, H_Content_Encoding);
317
318 304
        *vdc->clen = -1;
319
320 304
        if (vdc->oc == NULL)
321 68
                return (0);
322
323 236
        boc = HSH_RefBoc(vdc->oc);
324 236
        if (boc != NULL) {
325 44
                CHECK_OBJ(boc, BOC_MAGIC);
326 44
                bos = boc->state;
327 44
                HSH_DerefBoc(vdc->wrk, vdc->oc);
328 44
                if (bos < BOS_FINISHED)
329 44
                        return (0); /* OA_GZIPBITS is not stable yet */
330 0
        }
331
332 192
        p = ObjGetAttr(vdc->wrk, vdc->oc, OA_GZIPBITS, &dl);
333 192
        if (p != NULL && dl == 32) {
334 192
                u = vbe64dec(p + 24);
335 192
                if (u != 0)
336 188
                        *vdc->clen = u;
337 192
        }
338 192
        return (0);
339 304
}
340
341
static int v_matchproto_(vdp_fini_f)
342 304
vdp_gunzip_fini(struct vdp_ctx *vdc, void **priv)
343
{
344
        struct vgz *vg;
345
346 304
        (void)vdc;
347 304
        TAKE_OBJ_NOTNULL(vg, priv, VGZ_MAGIC);
348 304
        AN(vg->m_buf);
349 304
        (void)VGZ_Destroy(&vg);
350 304
        return (0);
351
}
352
353
static int v_matchproto_(vdp_bytes_f)
354 1739
vdp_gunzip_bytes(struct vdp_ctx *vdc, enum vdp_action act, void **priv,
355
    const void *ptr, ssize_t len)
356
{
357
        enum vgzret_e vr;
358
        ssize_t dl;
359
        const void *dp;
360
        struct worker *wrk;
361
        struct vgz *vg;
362
363 1739
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
364 1739
        wrk = vdc->wrk;
365 1739
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
366 1739
        (void)act;
367
368 1739
        CAST_OBJ_NOTNULL(vg, *priv, VGZ_MAGIC);
369 1739
        AN(vg->m_buf);
370
371 1739
        if (len == 0)
372 467
                return (0);
373
374 1272
        VGZ_Ibuf(vg, ptr, len);
375 1272
        do {
376 1272
                vr = VGZ_Gunzip(vg, &dp, &dl);
377 1272
                if (vr == VGZ_END && !VGZ_IbufEmpty(vg)) {
378 8
                        VSLb(vg->vsl, SLT_Gzip, "G(un)zip error: %d (%s)",
379 4
                             vr, "junk after VGZ_END");
380 4
                        return (-1);
381
                }
382 1268
                vg->m_len += dl;
383 1268
                if (vr < VGZ_OK)
384 0
                        return (-1);
385 1268
                if (vg->m_len == vg->m_sz || vr != VGZ_OK) {
386 584
                        if (VDP_bytes(vdc, vr == VGZ_END ? VDP_END : VDP_FLUSH,
387 292
                            vg->m_buf, vg->m_len))
388 16
                                return (vdc->retval);
389 276
                        vg->m_len = 0;
390 276
                        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
391 276
                }
392 1252
        } while (!VGZ_IbufEmpty(vg));
393 1252
        assert(vr == VGZ_STUCK || vr == VGZ_OK || vr == VGZ_END);
394 1252
        return (0);
395 1739
}
396
397
const struct vdp VDP_gunzip = {
398
        .name =         "gunzip",
399
        .init =         vdp_gunzip_init,
400
        .bytes =        vdp_gunzip_bytes,
401
        .fini =         vdp_gunzip_fini,
402
};
403
404
/*--------------------------------------------------------------------*/
405
406
void
407 4980
VGZ_UpdateObj(const struct vfp_ctx *vc, struct vgz *vg, enum vgzret_e e)
408
{
409
        char *p;
410
        intmax_t ii;
411
412 4980
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
413 4980
        if (e < VGZ_OK)
414 0
                return;
415 4980
        ii = vg->vz.start_bit + vg->vz.last_bit + vg->vz.stop_bit;
416 4980
        if (e != VGZ_END && ii == vg->bits)
417 3652
                return;
418 1328
        vg->bits = ii;
419 1328
        p = ObjSetAttr(vc->wrk, vc->oc, OA_GZIPBITS, 32, NULL);
420 1328
        AN(p);
421 1328
        vbe64enc(p, vg->vz.start_bit);
422 1328
        vbe64enc(p + 8, vg->vz.last_bit);
423 1328
        vbe64enc(p + 16, vg->vz.stop_bit);
424 1328
        if (e != VGZ_END)
425 508
                return;
426 820
        if (vg->dir == VGZ_GZ)
427 696
                vbe64enc(p + 24, vg->vz.total_in);
428 820
        if (vg->dir == VGZ_UN)
429 124
                vbe64enc(p + 24, vg->vz.total_out);
430 4980
}
431
432
/*--------------------------------------------------------------------
433
 */
434
435
enum vgzret_e
436 1292
VGZ_Destroy(struct vgz **vgp)
437
{
438
        struct vgz *vg;
439
        enum vgzret_e vr;
440
        int i;
441
442 1292
        TAKE_OBJ_NOTNULL(vg, vgp, VGZ_MAGIC);
443 1292
        AN(vg->id);
444 2584
        VSLb(vg->vsl, SLT_Gzip, "%s %jd %jd %jd %jd %jd",
445 1292
            vg->id,
446 1292
            (intmax_t)vg->vz.total_in,
447 1292
            (intmax_t)vg->vz.total_out,
448 1292
            (intmax_t)vg->vz.start_bit,
449 1292
            (intmax_t)vg->vz.last_bit,
450 1292
            (intmax_t)vg->vz.stop_bit);
451 1292
        if (vg->dir == VGZ_GZ)
452 368
                i = deflateEnd(&vg->vz);
453
        else
454 924
                i = inflateEnd(&vg->vz);
455 1292
        if (vg->last_i == Z_STREAM_END && i == Z_OK)
456 1032
                i = Z_STREAM_END;
457 1292
        if (vg->m_buf)
458 988
                free(vg->m_buf);
459 1292
        if (i == Z_OK)
460 252
                vr = VGZ_OK;
461 1040
        else if (i == Z_STREAM_END)
462 1032
                vr = VGZ_END;
463 8
        else if (i == Z_BUF_ERROR)
464 0
                vr = VGZ_STUCK;
465
        else {
466 16
                VSLb(vg->vsl, SLT_Gzip, "G(un)zip error: %d (%s)",
467 8
                    i, vgz_msg(vg));
468 8
                vr = VGZ_ERROR;
469
        }
470 1292
        FREE_OBJ(vg);
471 1292
        return (vr);
472
}
473
474
/*--------------------------------------------------------------------*/
475
476
static enum vfp_status v_matchproto_(vfp_init_f)
477 700
vfp_gzip_init(VRT_CTX, struct vfp_ctx *vc, struct vfp_entry *vfe)
478
{
479
        struct vgz *vg;
480
481 700
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
482 700
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
483 700
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
484
485
        /*
486
         * G(un)zip makes no sence on partial responses, but since
487
         * it is an pure 1:1 transform, we can just ignore it.
488
         */
489 700
        if (http_GetStatus(vc->resp) == 206)
490 16
                return (VFP_NULL);
491
492 684
        if (vfe->vfp == &VFP_gzip) {
493 64
                if (http_GetHdr(vc->resp, H_Content_Encoding, NULL))
494 0
                        return (VFP_NULL);
495 64
                vg = VGZ_NewGzip(vc->wrk->vsl, vfe->vfp->priv1);
496 64
                vc->obj_flags |= OF_GZIPED | OF_CHGCE;
497 64
        } else {
498 620
                if (!http_HdrIs(vc->resp, H_Content_Encoding, "gzip"))
499 0
                        return (VFP_NULL);
500 620
                if (vfe->vfp == &VFP_gunzip) {
501 500
                        vg = VGZ_NewGunzip(vc->wrk->vsl, vfe->vfp->priv1);
502 500
                        vc->obj_flags &= ~OF_GZIPED;
503 500
                        vc->obj_flags |= OF_CHGCE;
504 500
                } else {
505 120
                        vg = VGZ_NewTestGunzip(vc->wrk->vsl, vfe->vfp->priv1);
506 120
                        vc->obj_flags |= OF_GZIPED;
507
                }
508
        }
509 684
        AN(vg);
510 684
        vfe->priv1 = vg;
511 684
        if (vgz_getmbuf(vg))
512 0
                return (VFP_ERROR);
513 684
        VGZ_Ibuf(vg, vg->m_buf, 0);
514 684
        AZ(vg->m_len);
515
516 684
        if (vfe->vfp == &VFP_gunzip || vfe->vfp == &VFP_gzip) {
517 564
                http_Unset(vc->resp, H_Content_Encoding);
518 564
                http_Unset(vc->resp, H_Content_Length);
519 564
                RFC2616_Weaken_Etag(vc->resp);
520 564
        }
521
522 684
        if (vfe->vfp == &VFP_gzip)
523 64
                http_SetHeader(vc->resp, "Content-Encoding: gzip");
524
525 684
        if (vfe->vfp == &VFP_gzip || vfe->vfp == &VFP_testgunzip)
526 184
                RFC2616_Vary_AE(vc->resp);
527
528 684
        return (VFP_OK);
529 700
}
530
531
/*--------------------------------------------------------------------
532
 * VFP_GUNZIP
533
 *
534
 * A VFP for gunzip'ing an object as we receive it from the backend
535
 */
536
537
static enum vfp_status v_matchproto_(vfp_pull_f)
538 1813
vfp_gunzip_pull(struct vfp_ctx *vc, struct vfp_entry *vfe, void *p,
539
    ssize_t *lp)
540
{
541
        ssize_t l;
542
        struct vgz *vg;
543 1813
        enum vgzret_e vr = VGZ_ERROR;
544
        const void *dp;
545
        ssize_t dl;
546 1813
        enum vfp_status vp = VFP_OK;
547
548 1813
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
549 1813
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
550 1813
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
551 1813
        AN(p);
552 1813
        AN(lp);
553 1813
        l = *lp;
554 1813
        *lp = 0;
555 1813
        VGZ_Obuf(vg, p, l);
556 1813
        do {
557 1821
                if (VGZ_IbufEmpty(vg)) {
558 580
                        l = vg->m_sz;
559 580
                        vp = VFP_Suck(vc, vg->m_buf, &l);
560 580
                        if (vp == VFP_ERROR)
561 0
                                return (vp);
562 580
                        VGZ_Ibuf(vg, vg->m_buf, l);
563 580
                }
564 1821
                if (!VGZ_IbufEmpty(vg) || vp == VFP_END) {
565 1821
                        vr = VGZ_Gunzip(vg, &dp, &dl);
566 1821
                        if (vr == VGZ_END && !VGZ_IbufEmpty(vg))
567 4
                                return (VFP_Error(vc, "Junk after gzip data"));
568 1817
                        if (vr < VGZ_OK)
569 16
                                return (VFP_Error(vc,
570 8
                                    "Invalid Gzip data: %s", vgz_msg(vg)));
571 1809
                        if (dl > 0) {
572 1521
                                *lp = dl;
573 1521
                                assert(dp == p);
574 1521
                                return (VFP_OK);
575
                        }
576 288
                }
577 288
                AN(VGZ_IbufEmpty(vg));
578 288
        } while (vp == VFP_OK);
579 280
        if (vr != VGZ_END)
580 4
                return (VFP_Error(vc, "Gunzip error at the very end"));
581 276
        return (vp);
582 1813
}
583
584
585
/*--------------------------------------------------------------------
586
 * VFP_GZIP
587
 *
588
 * A VFP for gzip'ing an object as we receive it from the backend
589
 */
590
591
static enum vfp_status v_matchproto_(vfp_pull_f)
592 252
vfp_gzip_pull(struct vfp_ctx *vc, struct vfp_entry *vfe, void *p,
593
    ssize_t *lp)
594
{
595
        ssize_t l;
596
        struct vgz *vg;
597 252
        enum vgzret_e vr = VGZ_ERROR;
598
        const void *dp;
599
        ssize_t dl;
600 252
        enum vfp_status vp = VFP_ERROR;
601
602 252
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
603 252
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
604 252
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
605 252
        AN(p);
606 252
        AN(lp);
607 252
        l = *lp;
608 252
        *lp = 0;
609 252
        VGZ_Obuf(vg, p, l);
610 252
        do {
611 268
                if (VGZ_IbufEmpty(vg)) {
612 252
                        l = vg->m_sz;
613 252
                        vp = VFP_Suck(vc, vg->m_buf, &l);
614 252
                        if (vp == VFP_ERROR)
615 0
                                break;
616 252
                        if (vp == VFP_END)
617 88
                                vg->flag = VGZ_FINISH;
618 252
                        VGZ_Ibuf(vg, vg->m_buf, l);
619 252
                }
620 268
                if (!VGZ_IbufEmpty(vg) || vg->flag == VGZ_FINISH) {
621 268
                        vr = VGZ_Gzip(vg, &dp, &dl, vg->flag);
622 268
                        if (vr < VGZ_OK)
623 0
                                return (VFP_Error(vc, "Gzip failed"));
624 268
                        if (dl > 0) {
625 252
                                VGZ_UpdateObj(vc, vg, vr);
626 252
                                *lp = dl;
627 252
                                assert(dp == p);
628 252
                                if (vr != VGZ_END || !VGZ_IbufEmpty(vg))
629 192
                                        return (VFP_OK);
630 60
                        }
631 76
                }
632 76
                AN(VGZ_IbufEmpty(vg));
633 76
        } while (vg->flag != VGZ_FINISH);
634
635 60
        if (vr != VGZ_END)
636 0
                return (VFP_Error(vc, "Gzip failed"));
637 60
        VGZ_UpdateObj(vc, vg, VGZ_END);
638 60
        return (VFP_END);
639 252
}
640
641
/*--------------------------------------------------------------------
642
 * VFP_TESTGZIP
643
 *
644
 * A VFP for testing that received gzip data is valid, and for
645
 * collecting the magic bits while we're at it.
646
 */
647
648
static enum vfp_status v_matchproto_(vfp_pull_f)
649 156
vfp_testgunzip_pull(struct vfp_ctx *vc, struct vfp_entry *vfe, void *p,
650
    ssize_t *lp)
651
{
652
        struct vgz *vg;
653 156
        enum vgzret_e vr = VGZ_ERROR;
654
        const void *dp;
655
        ssize_t dl;
656
        enum vfp_status vp;
657
658 156
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
659 156
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
660 156
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
661 156
        AN(p);
662 156
        AN(lp);
663 156
        vp = VFP_Suck(vc, p, lp);
664 156
        if (vp == VFP_ERROR)
665 8
                return (vp);
666 148
        if (*lp > 0 || vp == VFP_END) {
667 148
                VGZ_Ibuf(vg, p, *lp);
668 148
                do {
669 148
                        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
670 148
                        vr = VGZ_Gunzip(vg, &dp, &dl);
671 148
                        if (vr == VGZ_END && !VGZ_IbufEmpty(vg))
672 12
                                return (VFP_Error(vc, "Junk after gzip data"));
673 136
                        if (vr < VGZ_OK)
674 0
                                return (VFP_Error(vc,
675 0
                                    "Invalid Gzip data: %s", vgz_msg(vg)));
676 136
                } while (!VGZ_IbufEmpty(vg));
677 136
        }
678 136
        VGZ_UpdateObj(vc, vg, vr);
679 136
        if (vp == VFP_END && vr != VGZ_END)
680 4
                return (VFP_Error(vc, "tGunzip failed"));
681 132
        return (vp);
682 156
}
683
684
/*--------------------------------------------------------------------*/
685
686
static void v_matchproto_(vfp_fini_f)
687 744
vfp_gzip_fini(struct vfp_ctx *vc, struct vfp_entry *vfe)
688
{
689
        struct vgz *vg;
690
691 744
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
692 744
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
693
694 744
        if (vfe->priv1 != NULL) {
695 684
                TAKE_OBJ_NOTNULL(vg, &vfe->priv1, VGZ_MAGIC);
696 684
                (void)VGZ_Destroy(&vg);
697 684
        }
698 744
}
699
700
/*--------------------------------------------------------------------*/
701
702
const struct vfp VFP_gunzip = {
703
        .name = "gunzip",
704
        .init = vfp_gzip_init,
705
        .pull = vfp_gunzip_pull,
706
        .fini = vfp_gzip_fini,
707
        .priv1 = "U F -",
708
};
709
710
const struct vfp VFP_gzip = {
711
        .name = "gzip",
712
        .init = vfp_gzip_init,
713
        .pull = vfp_gzip_pull,
714
        .fini = vfp_gzip_fini,
715
        .priv1 = "G F -",
716
};
717
718
const struct vfp VFP_testgunzip = {
719
        .name = "testgunzip",
720
        .init = vfp_gzip_init,
721
        .pull = vfp_testgunzip_pull,
722
        .fini = vfp_gzip_fini,
723
        .priv1 = "u F -",
724
};