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 30
vgz_msg(const struct vgz *vg)
72
{
73 30
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
74 30
        return (vg->vz.msg ? vg->vz.msg : "(null)");
75
}
76
77
/*--------------------------------------------------------------------
78
 * Set up a gunzip instance
79
 */
80
81
static struct vgz *
82 1155
vgz_gunzip(struct vsl_log *vsl, const char *id)
83
{
84
        struct vgz *vg;
85
86 1155
        ALLOC_OBJ(vg, VGZ_MAGIC);
87 1155
        AN(vg);
88 1155
        vg->vsl = vsl;
89 1155
        vg->id = id;
90 1155
        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 1155
        assert(Z_OK == inflateInit2(&vg->vz, 31));
99 1155
        return (vg);
100
}
101
102
static struct vgz *
103 1005
VGZ_NewGunzip(struct vsl_log *vsl, const char *id)
104
{
105 1005
        VSC_C_main->n_gunzip++;
106 1005
        return (vgz_gunzip(vsl, id));
107
}
108
109
static struct vgz *
110 150
VGZ_NewTestGunzip(struct vsl_log *vsl, const char *id)
111
{
112 150
        VSC_C_main->n_test_gunzip++;
113 150
        return (vgz_gunzip(vsl, id));
114
}
115
116
struct vgz *
117 460
VGZ_NewGzip(struct vsl_log *vsl, const char *id)
118
{
119
        struct vgz *vg;
120
        int i;
121
122 460
        VSC_C_main->n_gzip++;
123 460
        ALLOC_OBJ(vg, VGZ_MAGIC);
124 460
        AN(vg);
125 460
        vg->vsl = vsl;
126 460
        vg->id = id;
127 460
        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 460
        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 460
        assert(Z_OK == i);
146 460
        return (vg);
147
}
148
149
/*--------------------------------------------------------------------
150
 */
151
152
static int
153 1235
vgz_getmbuf(struct vgz *vg)
154
{
155
156 1235
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
157 1235
        AZ(vg->m_sz);
158 1235
        AZ(vg->m_len);
159 1235
        AZ(vg->m_buf);
160
161 1235
        vg->m_sz = cache_param->gzip_buffer;
162 1235
        vg->m_buf = malloc(vg->m_sz);
163 1235
        if (vg->m_buf == NULL) {
164 0
                vg->m_sz = 0;
165 0
                return (-1);
166
        }
167 1235
        return (0);
168 1235
}
169
170
/*--------------------------------------------------------------------*/
171
172
void
173 8363
VGZ_Ibuf(struct vgz *vg, const void *ptr, ssize_t len)
174
{
175
176 8363
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
177
178 8363
        AZ(vg->vz.avail_in);
179 8363
        vg->vz.next_in = TRUST_ME(ptr);
180 8363
        vg->vz.avail_in = len;
181 8363
}
182
183
int
184 18848
VGZ_IbufEmpty(const struct vgz *vg)
185
{
186
187 18848
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
188 18848
        return (vg->vz.avail_in == 0);
189
}
190
191
/*--------------------------------------------------------------------*/
192
193
void
194 8877
VGZ_Obuf(struct vgz *vg, void *ptr, ssize_t len)
195
{
196
197 8877
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
198
199 8877
        vg->vz.next_out = TRUST_ME(ptr);
200 8877
        vg->vz.avail_out = len;
201 8877
}
202
203
int
204 5338
VGZ_ObufFull(const struct vgz *vg)
205
{
206
207 5338
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
208 5338
        return (vg->vz.avail_out == 0);
209
}
210
211
/*--------------------------------------------------------------------*/
212
213
static enum vgzret_e
214 4098
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 4098
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
221
222 4098
        *pptr = NULL;
223 4098
        *plen = 0;
224 4098
        AN(vg->vz.next_out);
225 4098
        AN(vg->vz.avail_out);
226 4098
        before = vg->vz.next_out;
227 4098
        i = inflate(&vg->vz, 0);
228 4098
        if (i == Z_OK || i == Z_STREAM_END) {
229 4078
                *pptr = before;
230 4078
                l = (const uint8_t *)vg->vz.next_out - before;
231 4078
                *plen = l;
232 4078
        }
233 4098
        vg->last_i = i;
234 4098
        if (i == Z_OK)
235 2838
                return (VGZ_OK);
236 1260
        if (i == Z_STREAM_END)
237 1240
                return (VGZ_END);
238 20
        if (i == Z_BUF_ERROR)
239 10
                return (VGZ_STUCK);
240 10
        VSLb(vg->vsl, SLT_Gzip, "Gunzip error: %d (%s)", i, vgz_msg(vg));
241 10
        return (VGZ_ERROR);
242 4098
}
243
244
/*--------------------------------------------------------------------*/
245
246
enum vgzret_e
247 5673
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 5673
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
255
256 5673
        *pptr = NULL;
257 5673
        *plen = 0;
258 5673
        AN(vg->vz.next_out);
259 5673
        AN(vg->vz.avail_out);
260 5673
        before = vg->vz.next_out;
261 5673
        switch (flags) {
262 3733
        case VGZ_NORMAL:        zflg = Z_NO_FLUSH; break;
263 625
        case VGZ_ALIGN:         zflg = Z_SYNC_FLUSH; break;
264 630
        case VGZ_RESET:         zflg = Z_FULL_FLUSH; break;
265 685
        case VGZ_FINISH:        zflg = Z_FINISH; break;
266 0
        default:                WRONG("Invalid VGZ flag");
267 0
        }
268 5673
        i = deflate(&vg->vz, zflg);
269 5673
        if (i == Z_OK || i == Z_STREAM_END) {
270 5673
                *pptr = before;
271 5673
                l = (const uint8_t *)vg->vz.next_out - before;
272 5673
                *plen = l;
273 5673
        }
274 5673
        vg->last_i = i;
275 5673
        if (i == Z_OK)
276 5238
                return (VGZ_OK);
277 435
        if (i == Z_STREAM_END)
278 435
                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 5673
}
284
285
/*--------------------------------------------------------------------
286
 * VDP for gunzip'ing
287
 */
288
289
static int v_matchproto_(vdp_init_f)
290 380
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 380
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
300 380
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
301 380
        CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
302 380
        CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
303 380
        AN(vdc->clen);
304 380
        AN(priv);
305
306 380
        vg = VGZ_NewGunzip(vdc->vsl, "U D -");
307 380
        AN(vg);
308 380
        if (vgz_getmbuf(vg)) {
309 0
                (void)VGZ_Destroy(&vg);
310 0
                return (-1);
311
        }
312
313 380
        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
314 380
        *priv = vg;
315
316 380
        http_Unset(vdc->hp, H_Content_Encoding);
317
318 380
        *vdc->clen = -1;
319
320 380
        if (vdc->oc == NULL)
321 85
                return (0);
322
323 295
        boc = HSH_RefBoc(vdc->oc);
324 295
        if (boc != NULL) {
325 55
                CHECK_OBJ(boc, BOC_MAGIC);
326 55
                bos = boc->state;
327 55
                HSH_DerefBoc(vdc->wrk, vdc->oc);
328 55
                if (bos < BOS_FINISHED)
329 55
                        return (0); /* OA_GZIPBITS is not stable yet */
330 0
        }
331
332 240
        p = ObjGetAttr(vdc->wrk, vdc->oc, OA_GZIPBITS, &dl);
333 240
        if (p != NULL && dl == 32) {
334 240
                u = vbe64dec(p + 24);
335 240
                if (u != 0)
336 235
                        *vdc->clen = u;
337 240
        }
338 240
        return (0);
339 380
}
340
341
static int v_matchproto_(vdp_fini_f)
342 380
vdp_gunzip_fini(struct vdp_ctx *vdc, void **priv)
343
{
344
        struct vgz *vg;
345
346 380
        (void)vdc;
347 380
        TAKE_OBJ_NOTNULL(vg, priv, VGZ_MAGIC);
348 380
        AN(vg->m_buf);
349 380
        (void)VGZ_Destroy(&vg);
350 380
        return (0);
351
}
352
353
static int v_matchproto_(vdp_bytes_f)
354 2174
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 2174
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
364 2174
        wrk = vdc->wrk;
365 2174
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
366 2174
        (void)act;
367
368 2174
        CAST_OBJ_NOTNULL(vg, *priv, VGZ_MAGIC);
369 2174
        AN(vg->m_buf);
370
371 2174
        if (len == 0)
372 585
                return (0);
373
374 1589
        VGZ_Ibuf(vg, ptr, len);
375 1589
        do {
376 1589
                vr = VGZ_Gunzip(vg, &dp, &dl);
377 1589
                if (vr == VGZ_END && !VGZ_IbufEmpty(vg)) {
378 10
                        VSLb(vg->vsl, SLT_Gzip, "G(un)zip error: %d (%s)",
379 5
                             vr, "junk after VGZ_END");
380 5
                        return (-1);
381
                }
382 1584
                vg->m_len += dl;
383 1584
                if (vr < VGZ_OK)
384 0
                        return (-1);
385 1584
                if (vg->m_len == vg->m_sz || vr != VGZ_OK) {
386 730
                        if (VDP_bytes(vdc, vr == VGZ_END ? VDP_END : VDP_FLUSH,
387 365
                            vg->m_buf, vg->m_len))
388 20
                                return (vdc->retval);
389 345
                        vg->m_len = 0;
390 345
                        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
391 345
                }
392 1564
        } while (!VGZ_IbufEmpty(vg));
393 1564
        assert(vr == VGZ_STUCK || vr == VGZ_OK || vr == VGZ_END);
394 1564
        return (0);
395 2174
}
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 6258
VGZ_UpdateObj(const struct vfp_ctx *vc, struct vgz *vg, enum vgzret_e e)
408
{
409
        char *p;
410
        intmax_t ii;
411
412 6258
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
413 6258
        if (e < VGZ_OK)
414 0
                return;
415 6258
        ii = vg->vz.start_bit + vg->vz.last_bit + vg->vz.stop_bit;
416 6258
        if (e != VGZ_END && ii == vg->bits)
417 4598
                return;
418 1660
        vg->bits = ii;
419 1660
        p = ObjSetAttr(vc->wrk, vc->oc, OA_GZIPBITS, 32, NULL);
420 1660
        AN(p);
421 1660
        vbe64enc(p, vg->vz.start_bit);
422 1660
        vbe64enc(p + 8, vg->vz.last_bit);
423 1660
        vbe64enc(p + 16, vg->vz.stop_bit);
424 1660
        if (e != VGZ_END)
425 635
                return;
426 1025
        if (vg->dir == VGZ_GZ)
427 870
                vbe64enc(p + 24, vg->vz.total_in);
428 1025
        if (vg->dir == VGZ_UN)
429 155
                vbe64enc(p + 24, vg->vz.total_out);
430 6258
}
431
432
/*--------------------------------------------------------------------
433
 */
434
435
enum vgzret_e
436 1615
VGZ_Destroy(struct vgz **vgp)
437
{
438
        struct vgz *vg;
439
        enum vgzret_e vr;
440
        int i;
441
442 1615
        TAKE_OBJ_NOTNULL(vg, vgp, VGZ_MAGIC);
443 1615
        AN(vg->id);
444 3230
        VSLb(vg->vsl, SLT_Gzip, "%s %jd %jd %jd %jd %jd",
445 1615
            vg->id,
446 1615
            (intmax_t)vg->vz.total_in,
447 1615
            (intmax_t)vg->vz.total_out,
448 1615
            (intmax_t)vg->vz.start_bit,
449 1615
            (intmax_t)vg->vz.last_bit,
450 1615
            (intmax_t)vg->vz.stop_bit);
451 1615
        if (vg->dir == VGZ_GZ)
452 460
                i = deflateEnd(&vg->vz);
453
        else
454 1155
                i = inflateEnd(&vg->vz);
455 1615
        if (vg->last_i == Z_STREAM_END && i == Z_OK)
456 1290
                i = Z_STREAM_END;
457 1615
        if (vg->m_buf)
458 1235
                free(vg->m_buf);
459 1615
        if (i == Z_OK)
460 315
                vr = VGZ_OK;
461 1300
        else if (i == Z_STREAM_END)
462 1290
                vr = VGZ_END;
463 10
        else if (i == Z_BUF_ERROR)
464 0
                vr = VGZ_STUCK;
465
        else {
466 20
                VSLb(vg->vsl, SLT_Gzip, "G(un)zip error: %d (%s)",
467 10
                    i, vgz_msg(vg));
468 10
                vr = VGZ_ERROR;
469
        }
470 1615
        FREE_OBJ(vg);
471 1615
        return (vr);
472
}
473
474
/*--------------------------------------------------------------------*/
475
476
static enum vfp_status v_matchproto_(vfp_init_f)
477 875
vfp_gzip_init(VRT_CTX, struct vfp_ctx *vc, struct vfp_entry *vfe)
478
{
479
        struct vgz *vg;
480
481 875
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
482 875
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
483 875
        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 875
        if (http_GetStatus(vc->resp) == 206)
490 20
                return (VFP_NULL);
491
492 855
        if (vfe->vfp == &VFP_gzip) {
493 80
                if (http_GetHdr(vc->resp, H_Content_Encoding, NULL))
494 0
                        return (VFP_NULL);
495 80
                vg = VGZ_NewGzip(vc->wrk->vsl, vfe->vfp->priv1);
496 80
                vc->obj_flags |= OF_GZIPED | OF_CHGCE;
497 80
        } else {
498 775
                if (!http_HdrIs(vc->resp, H_Content_Encoding, "gzip"))
499 0
                        return (VFP_NULL);
500 775
                if (vfe->vfp == &VFP_gunzip) {
501 625
                        vg = VGZ_NewGunzip(vc->wrk->vsl, vfe->vfp->priv1);
502 625
                        vc->obj_flags &= ~OF_GZIPED;
503 625
                        vc->obj_flags |= OF_CHGCE;
504 625
                } else {
505 150
                        vg = VGZ_NewTestGunzip(vc->wrk->vsl, vfe->vfp->priv1);
506 150
                        vc->obj_flags |= OF_GZIPED;
507
                }
508
        }
509 855
        AN(vg);
510 855
        vfe->priv1 = vg;
511 855
        if (vgz_getmbuf(vg))
512 0
                return (VFP_ERROR);
513 855
        VGZ_Ibuf(vg, vg->m_buf, 0);
514 855
        AZ(vg->m_len);
515
516 855
        if (vfe->vfp == &VFP_gunzip || vfe->vfp == &VFP_gzip) {
517 705
                http_Unset(vc->resp, H_Content_Encoding);
518 705
                http_Unset(vc->resp, H_Content_Length);
519 705
                RFC2616_Weaken_Etag(vc->resp);
520 705
        }
521
522 855
        if (vfe->vfp == &VFP_gzip)
523 80
                http_SetHeader(vc->resp, "Content-Encoding: gzip");
524
525 855
        if (vfe->vfp == &VFP_gzip || vfe->vfp == &VFP_testgunzip)
526 230
                RFC2616_Vary_AE(vc->resp);
527
528 855
        return (VFP_OK);
529 875
}
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 2314
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 2314
        enum vgzret_e vr = VGZ_ERROR;
544
        const void *dp;
545
        ssize_t dl;
546 2314
        enum vfp_status vp = VFP_OK;
547
548 2314
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
549 2314
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
550 2314
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
551 2314
        AN(p);
552 2314
        AN(lp);
553 2314
        l = *lp;
554 2314
        *lp = 0;
555 2314
        VGZ_Obuf(vg, p, l);
556 2314
        do {
557 2324
                if (VGZ_IbufEmpty(vg)) {
558 725
                        l = vg->m_sz;
559 725
                        vp = VFP_Suck(vc, vg->m_buf, &l);
560 725
                        if (vp == VFP_ERROR)
561 0
                                return (vp);
562 725
                        VGZ_Ibuf(vg, vg->m_buf, l);
563 725
                }
564 2324
                if (!VGZ_IbufEmpty(vg) || vp == VFP_END) {
565 2324
                        vr = VGZ_Gunzip(vg, &dp, &dl);
566 2324
                        if (vr == VGZ_END && !VGZ_IbufEmpty(vg))
567 5
                                return (VFP_Error(vc, "Junk after gzip data"));
568 2319
                        if (vr < VGZ_OK)
569 20
                                return (VFP_Error(vc,
570 10
                                    "Invalid Gzip data: %s", vgz_msg(vg)));
571 2309
                        if (dl > 0) {
572 1949
                                *lp = dl;
573 1949
                                assert(dp == p);
574 1949
                                return (VFP_OK);
575
                        }
576 360
                }
577 360
                AN(VGZ_IbufEmpty(vg));
578 360
        } while (vp == VFP_OK);
579 350
        if (vr != VGZ_END)
580 5
                return (VFP_Error(vc, "Gunzip error at the very end"));
581 345
        return (vp);
582 2314
}
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 315
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 315
        enum vgzret_e vr = VGZ_ERROR;
598
        const void *dp;
599
        ssize_t dl;
600 315
        enum vfp_status vp = VFP_ERROR;
601
602 315
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
603 315
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
604 315
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
605 315
        AN(p);
606 315
        AN(lp);
607 315
        l = *lp;
608 315
        *lp = 0;
609 315
        VGZ_Obuf(vg, p, l);
610 315
        do {
611 335
                if (VGZ_IbufEmpty(vg)) {
612 315
                        l = vg->m_sz;
613 315
                        vp = VFP_Suck(vc, vg->m_buf, &l);
614 315
                        if (vp == VFP_ERROR)
615 0
                                break;
616 315
                        if (vp == VFP_END)
617 110
                                vg->flag = VGZ_FINISH;
618 315
                        VGZ_Ibuf(vg, vg->m_buf, l);
619 315
                }
620 335
                if (!VGZ_IbufEmpty(vg) || vg->flag == VGZ_FINISH) {
621 335
                        vr = VGZ_Gzip(vg, &dp, &dl, vg->flag);
622 335
                        if (vr < VGZ_OK)
623 0
                                return (VFP_Error(vc, "Gzip failed"));
624 335
                        if (dl > 0) {
625 315
                                VGZ_UpdateObj(vc, vg, vr);
626 315
                                *lp = dl;
627 315
                                assert(dp == p);
628 315
                                if (vr != VGZ_END || !VGZ_IbufEmpty(vg))
629 240
                                        return (VFP_OK);
630 75
                        }
631 95
                }
632 95
                AN(VGZ_IbufEmpty(vg));
633 95
        } while (vg->flag != VGZ_FINISH);
634
635 75
        if (vr != VGZ_END)
636 0
                return (VFP_Error(vc, "Gzip failed"));
637 75
        VGZ_UpdateObj(vc, vg, VGZ_END);
638 75
        return (VFP_END);
639 315
}
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 195
vfp_testgunzip_pull(struct vfp_ctx *vc, struct vfp_entry *vfe, void *p,
650
    ssize_t *lp)
651
{
652
        struct vgz *vg;
653 195
        enum vgzret_e vr = VGZ_ERROR;
654
        const void *dp;
655
        ssize_t dl;
656
        enum vfp_status vp;
657
658 195
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
659 195
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
660 195
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
661 195
        AN(p);
662 195
        AN(lp);
663 195
        vp = VFP_Suck(vc, p, lp);
664 195
        if (vp == VFP_ERROR)
665 10
                return (vp);
666 185
        if (*lp > 0 || vp == VFP_END) {
667 185
                VGZ_Ibuf(vg, p, *lp);
668 185
                do {
669 185
                        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
670 185
                        vr = VGZ_Gunzip(vg, &dp, &dl);
671 185
                        if (vr == VGZ_END && !VGZ_IbufEmpty(vg))
672 15
                                return (VFP_Error(vc, "Junk after gzip data"));
673 170
                        if (vr < VGZ_OK)
674 0
                                return (VFP_Error(vc,
675 0
                                    "Invalid Gzip data: %s", vgz_msg(vg)));
676 170
                } while (!VGZ_IbufEmpty(vg));
677 170
        }
678 170
        VGZ_UpdateObj(vc, vg, vr);
679 170
        if (vp == VFP_END && vr != VGZ_END)
680 5
                return (VFP_Error(vc, "tGunzip failed"));
681 165
        return (vp);
682 195
}
683
684
/*--------------------------------------------------------------------*/
685
686
static void v_matchproto_(vfp_fini_f)
687 930
vfp_gzip_fini(struct vfp_ctx *vc, struct vfp_entry *vfe)
688
{
689
        struct vgz *vg;
690
691 930
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
692 930
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
693
694 930
        if (vfe->priv1 != NULL) {
695 855
                TAKE_OBJ_NOTNULL(vg, &vfe->priv1, VGZ_MAGIC);
696 855
                (void)VGZ_Destroy(&vg);
697 855
        }
698 930
}
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
};