xref: /f-stack/freebsd/sys/compressor.h (revision 22ce4aff)
1*22ce4affSfengbojiang /*-
2*22ce4affSfengbojiang  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3*22ce4affSfengbojiang  *
4*22ce4affSfengbojiang  * Copyright (c) 2014, 2017 Mark Johnston <[email protected]>
5*22ce4affSfengbojiang  *
6*22ce4affSfengbojiang  * Redistribution and use in source and binary forms, with or without
7*22ce4affSfengbojiang  * modification, are permitted provided that the following conditions are
8*22ce4affSfengbojiang  * met:
9*22ce4affSfengbojiang  * 1. Redistributions of source code must retain the above copyright
10*22ce4affSfengbojiang  *    notice, this list of conditions and the following disclaimer.
11*22ce4affSfengbojiang  * 2. Redistributions in binary form must reproduce the above copyright
12*22ce4affSfengbojiang  *    notice, this list of conditions and the following disclaimer in
13*22ce4affSfengbojiang  *    the documentation and/or other materials provided with the
14*22ce4affSfengbojiang  *    distribution.
15*22ce4affSfengbojiang  *
16*22ce4affSfengbojiang  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17*22ce4affSfengbojiang  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*22ce4affSfengbojiang  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*22ce4affSfengbojiang  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20*22ce4affSfengbojiang  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*22ce4affSfengbojiang  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*22ce4affSfengbojiang  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*22ce4affSfengbojiang  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*22ce4affSfengbojiang  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*22ce4affSfengbojiang  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*22ce4affSfengbojiang  * SUCH DAMAGE.
27*22ce4affSfengbojiang  *
28*22ce4affSfengbojiang  * $FreeBSD$
29*22ce4affSfengbojiang  */
30*22ce4affSfengbojiang 
31*22ce4affSfengbojiang #ifndef _SYS__COMPRESSOR_H_
32*22ce4affSfengbojiang #define _SYS__COMPRESSOR_H_
33*22ce4affSfengbojiang 
34*22ce4affSfengbojiang #ifdef _KERNEL
35*22ce4affSfengbojiang 
36*22ce4affSfengbojiang /* Supported formats. */
37*22ce4affSfengbojiang #define	COMPRESS_GZIP	1
38*22ce4affSfengbojiang #define	COMPRESS_ZSTD	2
39*22ce4affSfengbojiang 
40*22ce4affSfengbojiang typedef int (*compressor_cb_t)(void *, size_t, off_t, void *);
41*22ce4affSfengbojiang 
42*22ce4affSfengbojiang struct compressor;
43*22ce4affSfengbojiang 
44*22ce4affSfengbojiang bool		compressor_avail(int format);
45*22ce4affSfengbojiang struct compressor *compressor_init(compressor_cb_t cb, int format,
46*22ce4affSfengbojiang 		    size_t maxiosize, int level, void *arg);
47*22ce4affSfengbojiang void		compressor_reset(struct compressor *stream);
48*22ce4affSfengbojiang int		compressor_write(struct compressor *stream, void *data,
49*22ce4affSfengbojiang 		    size_t len);
50*22ce4affSfengbojiang int		compressor_flush(struct compressor *stream);
51*22ce4affSfengbojiang void		compressor_fini(struct compressor *stream);
52*22ce4affSfengbojiang 
53*22ce4affSfengbojiang #endif /* _KERNEL */
54*22ce4affSfengbojiang #endif /* _SYS__COMPRESSOR_H_ */
55