1 /*-
2  * Copyright (c) 2011-2015 Varnish Software AS
3  * All rights reserved.
4  *
5  * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6  *
7  * SPDX-License-Identifier: BSD-2-Clause
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  */
31 
32 #ifdef CACHE_VGZ_H_INCLUDED
33 #  error "Multiple includes of cache/cache_vgz.h"
34 #endif
35 #define CACHE_VGZ_H_INCLUDED
36 
37 struct vgz;
38 
39 enum vgzret_e {
40 	VGZ_ERROR = -1,
41 	VGZ_OK = 0,
42 	VGZ_END = 1,
43 	VGZ_STUCK = 2,
44 };
45 
46 enum vgz_flag { VGZ_NORMAL, VGZ_ALIGN, VGZ_RESET, VGZ_FINISH };
47 // struct vgz *VGZ_NewUngzip(struct vsl_log *vsl, const char *id);
48 struct vgz *VGZ_NewGzip(struct vsl_log *vsl, const char *id);
49 void VGZ_Ibuf(struct vgz *, const void *, ssize_t len);
50 int VGZ_IbufEmpty(const struct vgz *vg);
51 void VGZ_Obuf(struct vgz *, void *, ssize_t len);
52 int VGZ_ObufFull(const struct vgz *vg);
53 enum vgzret_e VGZ_Gzip(struct vgz *, const void **, ssize_t *len,
54     enum vgz_flag);
55 // enum vgzret_e VGZ_Gunzip(struct vgz *, const void **, ssize_t *len);
56 enum vgzret_e VGZ_Destroy(struct vgz **);
57 
58 enum vgz_ua_e {
59 	VUA_UPDATE,		// Update start/stop/last bits if changed
60 	VUA_END_GZIP,		// Record uncompressed size
61 	VUA_END_GUNZIP,		// Record uncompressed size
62 };
63 
64 void VGZ_UpdateObj(const struct vfp_ctx *, struct vgz*, enum vgz_ua_e);
65