vinyl-cache/bin/vinyld/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_int.h"
45
#include "cache_filter.h"
46
#include "cache_objhead.h"
47
#include "cache_vgz.h"
48
49
#include "storage/storage.h"
50
51
#include "vend.h"
52
53
#include "vgz.h"
54
55
struct vgz {
56
        unsigned                magic;
57
#define VGZ_MAGIC               0x162df0cb
58
        enum {VGZ_GZ,VGZ_UN}    dir;
59
        struct vsl_log          *vsl;
60
        const char              *id;
61
        int                     last_i;
62
        enum vgz_flag           flag;
63
64
        struct stv_buffer       *stvbuf;
65
        char                    *m_buf;
66
        ssize_t                 m_sz;
67
        ssize_t                 m_len;
68
69
        intmax_t                bits;
70
71
        z_stream                vz;
72
};
73
74
static const char *
75 24
vgz_msg(const struct vgz *vg)
76
{
77 24
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
78 24
        return (vg->vz.msg ? vg->vz.msg : "(null)");
79
}
80
81
/*--------------------------------------------------------------------
82
 * Set up a gunzip instance
83
 */
84
85
static struct vgz *
86 1024
vgz_gunzip(struct vsl_log *vsl, const char *id)
87
{
88
        struct vgz *vg;
89
90 1024
        ALLOC_OBJ(vg, VGZ_MAGIC);
91 1024
        AN(vg);
92 1024
        vg->vsl = vsl;
93 1024
        vg->id = id;
94 1024
        vg->dir = VGZ_UN;
95
96
        /*
97
         * Max memory usage according to zonf.h:
98
         *      mem_needed = "a few kb" + (1 << (windowBits))
99
         * Since we don't control windowBits, we have to assume
100
         * it is 15, so 34-35KB or so.
101
         */
102 1024
        assert(Z_OK == inflateInit2(&vg->vz, 31));
103 1024
        return (vg);
104
}
105
106
static struct vgz *
107 900
VGZ_NewGunzip(struct vsl_log *vsl, const char *id)
108
{
109 900
        VSC_C_main->n_gunzip++;
110 900
        return (vgz_gunzip(vsl, id));
111
}
112
113
static struct vgz *
114 124
VGZ_NewTestGunzip(struct vsl_log *vsl, const char *id)
115
{
116 124
        VSC_C_main->n_test_gunzip++;
117 124
        return (vgz_gunzip(vsl, id));
118
}
119
120
struct vgz *
121 368
VGZ_NewGzip(struct vsl_log *vsl, const char *id)
122
{
123
        struct vgz *vg;
124
        int i;
125
126 368
        VSC_C_main->n_gzip++;
127 368
        ALLOC_OBJ(vg, VGZ_MAGIC);
128 368
        AN(vg);
129 368
        vg->vsl = vsl;
130 368
        vg->id = id;
131 368
        vg->dir = VGZ_GZ;
132
133
        /*
134
         * From zconf.h:
135
         *
136
         *      mem_needed = "a few kb"
137
         *              + (1 << (windowBits+2))
138
         *              +  (1 << (memLevel+9))
139
         *
140
         * windowBits [8..15] (-> 1K..128K)
141
         * memLevel [1..9] (-> 1K->256K)
142
         */
143 368
        i = deflateInit2(&vg->vz,
144
            cache_param->gzip_level,            /* Level */
145
            Z_DEFLATED,                         /* Method */
146
            16 + 15,                            /* Window bits (16=gzip) */
147
            cache_param->gzip_memlevel,         /* memLevel */
148
            Z_DEFAULT_STRATEGY);
149 368
        assert(Z_OK == i);
150 368
        return (vg);
151
}
152
153
/*--------------------------------------------------------------------
154
 */
155
156
static int
157 1088
vgz_getmbuf(struct worker *wrk, struct vgz *vg)
158
{
159
        size_t sz;
160
161 1088
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
162 1088
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
163 1088
        AZ(vg->m_sz);
164 1088
        AZ(vg->m_len);
165 1088
        AZ(vg->m_buf);
166 1088
        AZ(vg->stvbuf);
167
168 1088
        vg->stvbuf = STV_AllocBuf(wrk, stv_transient, cache_param->gzip_buffer);
169 1088
        if (vg->stvbuf == NULL)
170 0
                return (-1);
171 1088
        vg->m_buf = STV_GetBufPtr(vg->stvbuf, &sz);
172 1088
        vg->m_sz = sz;
173 1088
        AN(vg->m_buf);
174 1088
        assert(vg->m_sz > 0);
175 1088
        return (0);
176 1088
}
177
178
/*--------------------------------------------------------------------*/
179
180
void
181 6731
VGZ_Ibuf(struct vgz *vg, const void *ptr, ssize_t len)
182
{
183
184 6731
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
185 6731
        AZ(vg->vz.avail_in);
186 6731
        assert(len >= 0);
187 6731
        if (len > 0)
188 4539
                AN(ptr);
189
190 6731
        vg->vz.next_in = TRUST_ME(ptr);
191 6731
        vg->vz.avail_in = len;
192 6731
}
193
194
int
195 15125
VGZ_IbufEmpty(const struct vgz *vg)
196
{
197
198 15125
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
199 15125
        return (vg->vz.avail_in == 0);
200
}
201
202
/*--------------------------------------------------------------------*/
203
204
void
205 7227
VGZ_Obuf(struct vgz *vg, void *ptr, ssize_t len)
206
{
207
208 7227
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
209 7227
        AN(ptr);
210 7227
        assert(len > 0);
211
212 7227
        vg->vz.next_out = ptr;
213 7227
        vg->vz.avail_out = len;
214 7227
}
215
216
int
217 4286
VGZ_ObufFull(const struct vgz *vg)
218
{
219
220 4286
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
221 4286
        return (vg->vz.avail_out == 0);
222
}
223
224
/*--------------------------------------------------------------------*/
225
226
static enum vgzret_e
227 3293
VGZ_Gunzip(struct vgz *vg, const void **pptr, ssize_t *plen)
228
{
229
        int i;
230
        ssize_t l;
231
        const uint8_t *before;
232
233 3293
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
234
235 3293
        *pptr = NULL;
236 3293
        *plen = 0;
237 3293
        AN(vg->vz.next_out);
238 3293
        AN(vg->vz.avail_out);
239 3293
        before = vg->vz.next_out;
240 3293
        i = inflate(&vg->vz, 0);
241 3293
        if (i == Z_OK || i == Z_STREAM_END) {
242 3277
                *pptr = before;
243 3277
                l = (const uint8_t *)vg->vz.next_out - before;
244 3277
                *plen = l;
245 3277
        }
246 3293
        vg->last_i = i;
247 3293
        if (i == Z_OK)
248 2261
                return (VGZ_OK);
249 1032
        if (i == Z_STREAM_END)
250 1016
                return (VGZ_END);
251 16
        if (i == Z_BUF_ERROR)
252 8
                return (VGZ_STUCK);
253 8
        VSLb(vg->vsl, SLT_Gzip, "Gunzip error: %d (%s)", i, vgz_msg(vg));
254 8
        return (VGZ_ERROR);
255 3293
}
256
257
/* set vz pointers for in and out iovecs */
258
static inline void
259 64
vgz_iovec_update(struct vgz *vg, const struct iovec *in, const struct iovec *buf)
260
{
261
        /* in: either fully consumed or the same */
262 64
        assert(vg->vz.avail_in == 0 || vg->vz.next_in == TRUST_ME(in->iov_base));
263 64
        vg->vz.next_in = TRUST_ME(in->iov_base);
264 64
        vg->vz.avail_in = in->iov_len;
265 64
        vg->vz.next_out = TRUST_ME(buf->iov_base);
266 64
        vg->vz.avail_out = buf->iov_len;
267 64
}
268
269
static enum vgzret_e
270 64
vgz_gunzip_iovec(struct vgz *vg, struct iovec *in, struct iovec *buf, struct iovec *out)
271
{
272
        int i;
273
274 64
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
275 64
        AN(in && buf && out);
276 64
        vgz_iovec_update(vg, in, buf);
277
278 64
        i = inflate(&vg->vz, 0);
279 64
        if (i == Z_OK || i == Z_STREAM_END) {
280 64
                iovec_collect(buf, out, pdiff(buf->iov_base, vg->vz.next_out));
281 64
                in->iov_base = TRUST_ME(vg->vz.next_in);
282 64
                in->iov_len = vg->vz.avail_in;
283 64
        }
284 64
        vg->last_i = i;
285 64
        if (i == Z_OK)
286 0
                return (VGZ_OK);
287 64
        if (i == Z_STREAM_END)
288 64
                return (VGZ_END);
289 0
        if (i == Z_BUF_ERROR)
290 0
                return (VGZ_STUCK);
291 0
        VSLb(vg->vsl, SLT_Gzip, "Gunzip error: %d (%s)", i, vgz_msg(vg));
292 0
        return (VGZ_ERROR);
293 64
}
294
295
/*--------------------------------------------------------------------*/
296
297
enum vgzret_e
298 4550
VGZ_Gzip(struct vgz *vg, const void **pptr, ssize_t *plen, enum vgz_flag flags)
299
{
300
        int i;
301
        int zflg;
302
        ssize_t l;
303
        const uint8_t *before;
304
305 4550
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
306
307 4550
        *pptr = NULL;
308 4550
        *plen = 0;
309 4550
        AN(vg->vz.next_out);
310 4550
        AN(vg->vz.avail_out);
311 4550
        before = vg->vz.next_out;
312 4550
        switch (flags) {
313 2998
        case VGZ_NORMAL:        zflg = Z_NO_FLUSH; break;
314 500
        case VGZ_ALIGN:         zflg = Z_SYNC_FLUSH; break;
315 504
        case VGZ_RESET:         zflg = Z_FULL_FLUSH; break;
316 548
        case VGZ_FINISH:        zflg = Z_FINISH; break;
317 0
        default:                WRONG("Invalid VGZ flag");
318 0
        }
319 4550
        i = deflate(&vg->vz, zflg);
320 4550
        if (i == Z_OK || i == Z_STREAM_END) {
321 4550
                *pptr = before;
322 4550
                l = (const uint8_t *)vg->vz.next_out - before;
323 4550
                *plen = l;
324 4550
        }
325 4550
        vg->last_i = i;
326 4550
        if (i == Z_OK)
327 4202
                return (VGZ_OK);
328 348
        if (i == Z_STREAM_END)
329 348
                return (VGZ_END);
330 0
        if (i == Z_BUF_ERROR)
331 0
                return (VGZ_STUCK);
332 0
        VSLb(vg->vsl, SLT_Gzip, "Gzip error: %d (%s)", i, vgz_msg(vg));
333 0
        return (VGZ_ERROR);
334 4550
}
335
336
/*--------------------------------------------------------------------
337
 * VDP for gunzip'ing
338
 */
339
340
// common for traditional interface and vdpio
341
static int vdp_gunzip_init_common(struct vdp_ctx *vdc);
342
343
static int v_matchproto_(vdp_init_f)
344 400
vdp_gunzip_init(VRT_CTX, struct vdp_ctx *vdc, void **priv)
345
{
346
        struct vgz *vg;
347
348 400
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
349 400
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
350 400
        CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
351 400
        CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
352 400
        AN(vdc->clen);
353 400
        AN(priv);
354
355 400
        vg = VGZ_NewGunzip(vdc->vsl, "U D -");
356 400
        AN(vg);
357 400
        if (vgz_getmbuf(vdc->wrk, vg)) {
358 0
                (void)VGZ_Destroy(vdc->wrk, &vg);
359 0
                return (-1);
360
        }
361
362 400
        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
363 400
        *priv = vg;
364 400
        return (vdp_gunzip_init_common(vdc));
365 400
}
366
367
static int
368 400
vdp_gunzip_init_common(struct vdp_ctx *vdc)
369
{
370
        struct boc *boc;
371
        enum boc_state_e bos;
372
        const char *p;
373
        ssize_t dl;
374
        uint64_t u;
375 400
        http_Unset(vdc->hp, H_Content_Encoding);
376
377 400
        *vdc->clen = -1;
378
379 400
        if (vdc->oc == NULL)
380 68
                return (0);
381
382 332
        boc = HSH_RefBoc(vdc->oc);
383 332
        if (boc != NULL) {
384 52
                CHECK_OBJ(boc, BOC_MAGIC);
385 52
                bos = boc->state;
386 52
                HSH_DerefBoc(vdc->wrk, vdc->oc);
387 52
                if (bos < BOS_FINISHED)
388 52
                        return (0); /* OA_GZIPBITS is not stable yet */
389 0
        }
390
391 280
        p = ObjGetAttr(vdc->wrk, vdc->oc, OA_GZIPBITS, &dl);
392 280
        if (p != NULL && dl == 32) {
393 280
                u = vbe64dec(p + 24);
394 280
                if (u != 0)
395 276
                        *vdc->clen = u;
396 280
        }
397 280
        return (0);
398 400
}
399
400
static int v_matchproto_(vdp_fini_f)
401 336
vdp_gunzip_fini(struct vdp_ctx *vdc, void **priv)
402
{
403
        struct vgz *vg;
404
405 336
        (void)vdc;
406 336
        TAKE_OBJ_NOTNULL(vg, priv, VGZ_MAGIC);
407 336
        AN(vg->m_buf);
408 336
        (void)VGZ_Destroy(vdc->wrk, &vg);
409 336
        return (0);
410
}
411
412
static int v_matchproto_(vdp_bytes_f)
413 1772
vdp_gunzip_bytes(struct vdp_ctx *vdc, enum vdp_action act, void **priv,
414
    const void *ptr, ssize_t len)
415
{
416
        enum vgzret_e vr;
417
        ssize_t dl;
418
        const void *dp;
419
        struct vgz *vg;
420
421 1772
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
422 1772
        CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
423 1772
        (void)act;
424
425 1772
        CAST_OBJ_NOTNULL(vg, *priv, VGZ_MAGIC);
426 1772
        AN(vg->m_buf);
427
428 1772
        if (len == 0)
429 468
                return (0);
430
431 1304
        VGZ_Ibuf(vg, ptr, len);
432 1304
        do {
433 1304
                vr = VGZ_Gunzip(vg, &dp, &dl);
434 1304
                if (vr == VGZ_END && !VGZ_IbufEmpty(vg)) {
435 8
                        VSLb(vg->vsl, SLT_Gzip, "G(un)zip error: %d (%s)",
436 4
                             vr, "junk after VGZ_END");
437 4
                        return (-1);
438
                }
439 1300
                vg->m_len += dl;
440 1300
                if (vr < VGZ_OK)
441 0
                        return (-1);
442
                // END or STUCK
443 1300
                if (vg->m_len == vg->m_sz || vr != VGZ_OK) {
444 648
                        if (VDP_bytes(vdc, vr == VGZ_END ? VDP_END : VDP_FLUSH,
445 324
                            vg->m_buf, vg->m_len))
446 16
                                return (vdc->retval);
447 308
                        vg->m_len = 0;
448 308
                        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
449 308
                }
450 1284
        } while (!VGZ_IbufEmpty(vg));
451 1284
        assert(vr == VGZ_STUCK || vr == VGZ_OK || vr == VGZ_END);
452 1284
        return (0);
453 1772
}
454
455
#ifdef LATER
456
/*
457
 * XXX does it make sense to work on more than one buffer?
458
 */
459
static int v_matchproto_(vdpio_init_f)
460
vdpio_gunzip_init(VRT_CTX, struct vdp_ctx *vdc, void **priv, int capacity)
461
{
462
        struct vgz *vg;
463
        struct vscarab *in;
464
465
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
466
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
467
        CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
468
        CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
469
        AN(vdc->clen);
470
        AN(priv);
471
        assert(capacity >= 1);
472
473
        if (capacity < 4)
474
                capacity = 4;
475
476
        in = WS_Alloc(ctx->ws, VSCARAB_SIZE(capacity));
477
        if (in == NULL)
478
                return (-1);
479
        VSCARAB_INIT(in, capacity);
480
481
        vg = VGZ_NewGunzip(vdc->vsl, "U D -");
482
        if (vg == NULL)
483
                return (-1);
484
485
        AZ(vg->m_buf);
486
        vg->m_buf = (void *)in;
487
488
        *priv = vg;
489
        AZ(vdp_gunzip_init_common(vdc));
490
        return (1);
491
}
492
#endif
493
494
static int v_matchproto_(vdpio_init_f)
495 64
vdpio_gunzip_upgrade(VRT_CTX, struct vdp_ctx *vdc, void **priv, int capacity)
496
{
497
        struct vgz *vg;
498
        struct vscarab *in;
499
500 64
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
501 64
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
502 64
        AN(priv);
503 64
        assert(capacity >= 1);
504
505 64
        if (capacity < 4)
506 64
                capacity = 4;
507
508
        /* done in vdp_gunzip_init */
509 64
        CAST_OBJ_NOTNULL(vg, *priv, VGZ_MAGIC);
510
511 64
        in = WS_Alloc(ctx->ws, VSCARAB_SIZE(capacity));
512 64
        if (in == NULL)
513 0
                return (-1);
514 64
        VSCARAB_INIT(in, capacity);
515
516
        // XXX duplicate work - remove when completing transition to VAI
517 64
        AN(vg->m_buf);
518 64
        AN(vg->stvbuf);
519 64
        STV_FreeBuf(vdc->wrk, &vg->stvbuf);
520 64
        vg->stvbuf = NULL;
521 64
        vg->m_buf = (void *)in;
522
523 64
        return (1);
524 64
}
525
526
static int v_matchproto_(vdpio_lease_f)
527 64
vdpio_gunzip_lease(struct vdp_ctx *vdc, struct vdp_entry *this, struct vscarab *out)
528
{
529
        struct vscarab *in;
530
        enum vgzret_e vr;
531
        struct vgz *vg;
532
        struct viov *v, *b, *o;
533
        int r;
534
535 64
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
536 64
        CHECK_OBJ_NOTNULL(this, VDP_ENTRY_MAGIC);
537 64
        CAST_OBJ_NOTNULL(vg, this->priv, VGZ_MAGIC);
538 64
        CAST_OBJ_NOTNULL(in, (void*)vg->m_buf, VSCARAB_MAGIC);
539
540 64
        this->calls++;
541
542 64
        if (out->used == out->capacity)
543 0
                return (0);
544
545 64
        if (in->used < in->capacity && (in->flags & VSCARAB_F_END) == 0)
546 64
                r = vdpio_pull(vdc, this, in);
547
        else
548 0
                r = 0;
549
550 64
        if (in->used == 0) {
551 0
                out->flags = in->flags & VSCARAB_F_END;
552 0
                return (r);
553
        }
554
555
        // XXX more than one buffer?
556 64
        VSCARAB_LOCAL(buf, 1);
557 64
        b = VSCARAB_GET(buf);
558 64
        AN(b);
559 64
        b->iov.iov_len = cache_param->gzip_buffer;
560 64
        r = ObjVAIbuffer(vdc->wrk, vdc->vai_hdl, buf);
561 64
        if (r < 0)
562 0
                return (out->used ? 0 : r);
563
564 64
        o = VSCARAB_GET(out);
565 64
        AN(o);
566 64
        r = 0;
567
568 64
        VSCARAB_FOREACH(v, in) {
569 64
                this->bytes_in += v->iov.iov_len;
570 64
                vr = vgz_gunzip_iovec(vg, &v->iov, &b->iov, &o->iov);
571 64
                if (vr == VGZ_END && v->iov.iov_len > 0) {
572 0
                        VSLb(vg->vsl, SLT_Gzip, "G(un)zip error: %d (%s)",
573 0
                             vr, "junk after VGZ_END");
574 0
                        r = -EMSGSIZE;
575 0
                        break;
576
                }
577 64
                if (vr < VGZ_OK)
578 0
                        break;
579
580 64
                if (b->iov.iov_len == 0 || vr != VGZ_OK) {
581 64
                        r = 1;
582 64
                        break;
583
                }
584 0
        }
585
586 64
        if (r <= 0) {
587 0
                o->iov = IOV_NIL;
588 0
                vdpio_return_lease(vdc, b->lease);
589 0
                return (r);
590
        }
591
592 64
        o->lease = b->lease;
593 64
        b->lease = 0;
594
595 64
        vdpio_consolidate_vscarab(vdc, in);
596 64
        if (in->used == 0)
597 64
                out->flags = in->flags & VSCARAB_F_END;
598
599 64
        return (r);
600 64
}
601
602
static void v_matchproto_(vdpio_fini_f)
603 64
vdpio_gunzip_fini(struct vdp_ctx *vdc, void **priv)
604
{
605
        struct vscarab *in;
606
        struct vgz *vg;
607
608 64
        (void)vdc;
609 64
        TAKE_OBJ_NOTNULL(vg, priv, VGZ_MAGIC);
610 64
        CAST_OBJ_NOTNULL(in, (void *)vg->m_buf, VSCARAB_MAGIC);
611 64
        vg->m_buf = NULL;
612
613 64
        (void)VGZ_Destroy(vdc->wrk, &vg);
614 64
}
615
616
const struct vdp VDP_gunzip = {
617
        .name =         "gunzip",
618
        .init =         vdp_gunzip_init,
619
        .bytes =        vdp_gunzip_bytes,
620
        .fini =         vdp_gunzip_fini,
621
622
#ifdef LATER
623
        .io_init =      vdpio_gunzip_init,
624
#endif
625
        .io_upgrade =   vdpio_gunzip_upgrade,
626
        .io_lease =     vdpio_gunzip_lease,
627
        .io_fini =      vdpio_gunzip_fini,
628
};
629
630
/*--------------------------------------------------------------------*/
631
632
void
633 5015
VGZ_UpdateObj(const struct vfp_ctx *vc, struct vgz *vg, enum vgzret_e e)
634
{
635
        char *p;
636
        intmax_t ii;
637
638 5015
        CHECK_OBJ_NOTNULL(vg, VGZ_MAGIC);
639 5015
        if (e < VGZ_OK)
640 0
                return;
641 5015
        ii = vg->vz.start_bit + vg->vz.last_bit + vg->vz.stop_bit;
642 5015
        if (e != VGZ_END && ii == vg->bits)
643 3694
                return;
644 1321
        vg->bits = ii;
645 1321
        p = ObjSetAttr(vc->wrk, vc->oc, OA_GZIPBITS, 32, NULL);
646 1321
        AN(p);
647 1321
        vbe64enc(p, vg->vz.start_bit);
648 1321
        vbe64enc(p + 8, vg->vz.last_bit);
649 1321
        vbe64enc(p + 16, vg->vz.stop_bit);
650 1321
        if (e != VGZ_END)
651 509
                return;
652 812
        if (vg->dir == VGZ_GZ)
653 696
                vbe64enc(p + 24, vg->vz.total_in);
654 812
        if (vg->dir == VGZ_UN)
655 116
                vbe64enc(p + 24, vg->vz.total_out);
656 5015
}
657
658
/*--------------------------------------------------------------------
659
 */
660
661
enum vgzret_e
662 1392
VGZ_Destroy(struct worker *wrk, struct vgz **vgp)
663
{
664
        struct vgz *vg;
665
        enum vgzret_e vr;
666
        int i;
667
668 1392
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
669 1392
        TAKE_OBJ_NOTNULL(vg, vgp, VGZ_MAGIC);
670 1392
        AN(vg->id);
671 2784
        VSLb(vg->vsl, SLT_Gzip, "%s %jd %jd %jd %jd %jd",
672 1392
            vg->id,
673 1392
            (intmax_t)vg->vz.total_in,
674 1392
            (intmax_t)vg->vz.total_out,
675 1392
            (intmax_t)vg->vz.start_bit,
676 1392
            (intmax_t)vg->vz.last_bit,
677 1392
            (intmax_t)vg->vz.stop_bit);
678 1392
        if (vg->dir == VGZ_GZ)
679 368
                i = deflateEnd(&vg->vz);
680
        else
681 1024
                i = inflateEnd(&vg->vz);
682 1392
        if (vg->last_i == Z_STREAM_END && i == Z_OK)
683 1132
                i = Z_STREAM_END;
684 1392
        if (vg->m_buf != NULL) {
685 1024
                AN(vg->stvbuf);
686 1024
                STV_FreeBuf(wrk, &vg->stvbuf);
687 1024
        }
688 1392
        AZ(vg->stvbuf);
689 1392
        if (i == Z_OK)
690 252
                vr = VGZ_OK;
691 1140
        else if (i == Z_STREAM_END)
692 1132
                vr = VGZ_END;
693 8
        else if (i == Z_BUF_ERROR)
694 0
                vr = VGZ_STUCK;
695
        else {
696 16
                VSLb(vg->vsl, SLT_Gzip, "G(un)zip error: %d (%s)",
697 8
                    i, vgz_msg(vg));
698 8
                vr = VGZ_ERROR;
699
        }
700 1392
        FREE_OBJ(vg);
701 1392
        return (vr);
702
}
703
704
/*--------------------------------------------------------------------*/
705
706
static enum vfp_status v_matchproto_(vfp_init_f)
707 704
vfp_gzip_init(VRT_CTX, struct vfp_ctx *vc, struct vfp_entry *vfe)
708
{
709
        struct vgz *vg;
710
711 704
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
712 704
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
713 704
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
714
715
        /*
716
         * G(un)zip makes no sence on partial responses, but since
717
         * it is an pure 1:1 transform, we can just ignore it.
718
         */
719 704
        if (http_GetStatus(vc->resp) == 206)
720 16
                return (VFP_NULL);
721
722 688
        if (vfe->vfp == &VFP_gzip) {
723 64
                if (http_GetHdr(vc->resp, H_Content_Encoding, NULL))
724 0
                        return (VFP_NULL);
725 64
                vg = VGZ_NewGzip(vc->wrk->vsl, vfe->vfp->priv1);
726 64
                vc->obj_flags |= OF_GZIPED | OF_CHGCE;
727 64
        } else {
728 624
                if (!http_HdrIs(vc->resp, H_Content_Encoding, "gzip"))
729 0
                        return (VFP_NULL);
730 624
                if (vfe->vfp == &VFP_gunzip) {
731 500
                        vg = VGZ_NewGunzip(vc->wrk->vsl, vfe->vfp->priv1);
732 500
                        vc->obj_flags &= ~OF_GZIPED;
733 500
                        vc->obj_flags |= OF_CHGCE;
734 500
                } else {
735 124
                        vg = VGZ_NewTestGunzip(vc->wrk->vsl, vfe->vfp->priv1);
736 124
                        vc->obj_flags |= OF_GZIPED;
737
                }
738
        }
739 688
        AN(vg);
740 688
        vfe->priv1 = vg;
741 688
        if (vgz_getmbuf(vc->wrk, vg))
742 0
                return (VFP_ERROR);
743 688
        VGZ_Ibuf(vg, vg->m_buf, 0);
744 688
        AZ(vg->m_len);
745
746 688
        if (vfe->vfp == &VFP_gunzip || vfe->vfp == &VFP_gzip) {
747 564
                http_Unset(vc->resp, H_Content_Encoding);
748 564
                http_Unset(vc->resp, H_Content_Length);
749 564
                RFC2616_Weaken_Etag(vc->resp);
750 564
        }
751
752 688
        if (vfe->vfp == &VFP_gzip)
753 64
                http_SetHeader(vc->resp, "Content-Encoding: gzip");
754
755 688
        if (vfe->vfp == &VFP_gzip || vfe->vfp == &VFP_testgunzip)
756 188
                RFC2616_Vary_AE(vc->resp);
757
758 688
        return (VFP_OK);
759 704
}
760
761
/*--------------------------------------------------------------------
762
 * VFP_GUNZIP
763
 *
764
 * A VFP for gunzip'ing an object as we receive it from the backend
765
 */
766
767
static enum vfp_status v_matchproto_(vfp_pull_f)
768 1840
vfp_gunzip_pull(struct vfp_ctx *vc, struct vfp_entry *vfe, void *p,
769
    ssize_t *lp)
770
{
771
        ssize_t l;
772
        struct vgz *vg;
773 1840
        enum vgzret_e vr = VGZ_ERROR;
774
        const void *dp;
775
        ssize_t dl;
776 1840
        enum vfp_status vp = VFP_OK;
777
778 1840
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
779 1840
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
780 1840
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
781 1840
        AN(p);
782 1840
        AN(lp);
783 1840
        l = *lp;
784 1840
        *lp = 0;
785 1840
        VGZ_Obuf(vg, p, l);
786 1840
        do {
787 1848
                if (VGZ_IbufEmpty(vg)) {
788 580
                        l = vg->m_sz;
789 580
                        vp = VFP_Suck(vc, vg->m_buf, &l);
790 580
                        if (vp == VFP_ERROR)
791 0
                                return (vp);
792 580
                        VGZ_Ibuf(vg, vg->m_buf, l);
793 580
                }
794 1848
                if (!VGZ_IbufEmpty(vg) || vp == VFP_END) {
795 1848
                        vr = VGZ_Gunzip(vg, &dp, &dl);
796 1848
                        if (vr == VGZ_END && !VGZ_IbufEmpty(vg))
797 4
                                return (VFP_Error(vc, "Junk after gzip data"));
798 1844
                        if (vr < VGZ_OK)
799 16
                                return (VFP_Error(vc,
800 8
                                    "Invalid Gzip data: %s", vgz_msg(vg)));
801 1836
                        if (dl > 0) {
802 1548
                                *lp = dl;
803 1548
                                assert(dp == p);
804 1548
                                return (VFP_OK);
805
                        }
806 288
                }
807 288
                AN(VGZ_IbufEmpty(vg));
808 288
        } while (vp == VFP_OK);
809 280
        if (vr != VGZ_END)
810 4
                return (VFP_Error(vc, "Gunzip error at the very end"));
811 276
        return (vp);
812 1840
}
813
814
815
/*--------------------------------------------------------------------
816
 * VFP_GZIP
817
 *
818
 * A VFP for gzip'ing an object as we receive it from the backend
819
 */
820
821
static enum vfp_status v_matchproto_(vfp_pull_f)
822 252
vfp_gzip_pull(struct vfp_ctx *vc, struct vfp_entry *vfe, void *p,
823
    ssize_t *lp)
824
{
825
        ssize_t l;
826
        struct vgz *vg;
827 252
        enum vgzret_e vr = VGZ_ERROR;
828
        const void *dp;
829
        ssize_t dl;
830 252
        enum vfp_status vp = VFP_ERROR;
831
832 252
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
833 252
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
834 252
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
835 252
        AN(p);
836 252
        AN(lp);
837 252
        l = *lp;
838 252
        *lp = 0;
839 252
        VGZ_Obuf(vg, p, l);
840 252
        do {
841 264
                if (VGZ_IbufEmpty(vg)) {
842 248
                        l = vg->m_sz;
843 248
                        vp = VFP_Suck(vc, vg->m_buf, &l);
844 248
                        if (vp == VFP_ERROR)
845 0
                                break;
846 248
                        if (vp == VFP_END)
847 88
                                vg->flag = VGZ_FINISH;
848 248
                        VGZ_Ibuf(vg, vg->m_buf, l);
849 248
                }
850 264
                if (!VGZ_IbufEmpty(vg) || vg->flag == VGZ_FINISH) {
851 264
                        vr = VGZ_Gzip(vg, &dp, &dl, vg->flag);
852 264
                        if (vr < VGZ_OK)
853 0
                                return (VFP_Error(vc, "Gzip failed"));
854 264
                        if (dl > 0) {
855 252
                                VGZ_UpdateObj(vc, vg, vr);
856 252
                                *lp = dl;
857 252
                                assert(dp == p);
858 252
                                if (vr != VGZ_END || !VGZ_IbufEmpty(vg))
859 192
                                        return (VFP_OK);
860 60
                        }
861 72
                }
862 72
                AN(VGZ_IbufEmpty(vg));
863 72
        } while (vg->flag != VGZ_FINISH);
864
865 60
        if (vr != VGZ_END)
866 0
                return (VFP_Error(vc, "Gzip failed"));
867 60
        VGZ_UpdateObj(vc, vg, VGZ_END);
868 60
        return (VFP_END);
869 252
}
870
871
/*--------------------------------------------------------------------
872
 * VFP_TESTGZIP
873
 *
874
 * A VFP for testing that received gzip data is valid, and for
875
 * collecting the magic bits while we're at it.
876
 */
877
878
static enum vfp_status v_matchproto_(vfp_pull_f)
879 149
vfp_testgunzip_pull(struct vfp_ctx *vc, struct vfp_entry *vfe, void *p,
880
    ssize_t *lp)
881
{
882
        struct vgz *vg;
883 149
        enum vgzret_e vr = VGZ_ERROR;
884
        const void *dp;
885
        ssize_t dl;
886
        enum vfp_status vp;
887
888 149
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
889 149
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
890 149
        CAST_OBJ_NOTNULL(vg, vfe->priv1, VGZ_MAGIC);
891 149
        AN(p);
892 149
        AN(lp);
893 149
        vp = VFP_Suck(vc, p, lp);
894 149
        if (vp == VFP_ERROR)
895 8
                return (vp);
896 141
        if (*lp > 0 || vp == VFP_END) {
897 141
                VGZ_Ibuf(vg, p, *lp);
898 141
                do {
899 141
                        VGZ_Obuf(vg, vg->m_buf, vg->m_sz);
900 141
                        vr = VGZ_Gunzip(vg, &dp, &dl);
901 141
                        if (vr == VGZ_END && !VGZ_IbufEmpty(vg))
902 12
                                return (VFP_Error(vc, "Junk after gzip data"));
903 129
                        if (vr < VGZ_OK)
904 0
                                return (VFP_Error(vc,
905 0
                                    "Invalid Gzip data: %s", vgz_msg(vg)));
906 129
                } while (!VGZ_IbufEmpty(vg));
907 129
        }
908 129
        VGZ_UpdateObj(vc, vg, vr);
909 129
        if (vp == VFP_END && vr != VGZ_END)
910 4
                return (VFP_Error(vc, "tGunzip failed"));
911 125
        return (vp);
912 149
}
913
914
/*--------------------------------------------------------------------*/
915
916
static void v_matchproto_(vfp_fini_f)
917 748
vfp_gzip_fini(struct vfp_ctx *vc, struct vfp_entry *vfe)
918
{
919
        struct vgz *vg;
920
921 748
        CHECK_OBJ_NOTNULL(vc, VFP_CTX_MAGIC);
922 748
        CHECK_OBJ_NOTNULL(vfe, VFP_ENTRY_MAGIC);
923
924 748
        if (vfe->priv1 != NULL) {
925 688
                TAKE_OBJ_NOTNULL(vg, &vfe->priv1, VGZ_MAGIC);
926 688
                (void)VGZ_Destroy(vc->wrk, &vg);
927 688
        }
928 748
}
929
930
/*--------------------------------------------------------------------*/
931
932
const struct vfp VFP_gunzip = {
933
        .name = "gunzip",
934
        .init = vfp_gzip_init,
935
        .pull = vfp_gunzip_pull,
936
        .fini = vfp_gzip_fini,
937
        .priv1 = "U F -",
938
};
939
940
const struct vfp VFP_gzip = {
941
        .name = "gzip",
942
        .init = vfp_gzip_init,
943
        .pull = vfp_gzip_pull,
944
        .fini = vfp_gzip_fini,
945
        .priv1 = "G F -",
946
};
947
948
const struct vfp VFP_testgunzip = {
949
        .name = "testgunzip",
950
        .init = vfp_gzip_init,
951
        .pull = vfp_testgunzip_pull,
952
        .fini = vfp_gzip_fini,
953
        .priv1 = "u F -",
954
};