xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zio_compress.h (revision 522c768b8cd12cb4e80ed84c1eb5df0ed2fd2baa)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 /*
27  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
28  */
29 
30 #ifndef _SYS_ZIO_COMPRESS_H
31 #define	_SYS_ZIO_COMPRESS_H
32 
33 #include <sys/zio.h>
34 
35 #ifdef	__cplusplus
36 extern "C" {
37 #endif
38 
39 /* Common signature for all zio compress functions. */
40 typedef size_t zio_compress_func_t(void *src, void *dst,
41     size_t s_len, size_t d_len, int);
42 /* Common signature for all zio decompress functions. */
43 typedef int zio_decompress_func_t(void *src, void *dst,
44     size_t s_len, size_t d_len, int);
45 
46 /*
47  * Information about each compression function.
48  */
49 typedef struct zio_compress_info {
50 	zio_compress_func_t	*ci_compress;	/* compression function */
51 	zio_decompress_func_t	*ci_decompress;	/* decompression function */
52 	int			ci_level;	/* level parameter */
53 	char			*ci_name;	/* algorithm name */
54 } zio_compress_info_t;
55 
56 extern zio_compress_info_t zio_compress_table[ZIO_COMPRESS_FUNCTIONS];
57 
58 /*
59  * Compression routines.
60  */
61 extern size_t lzjb_compress(void *src, void *dst, size_t s_len, size_t d_len,
62     int level);
63 extern int lzjb_decompress(void *src, void *dst, size_t s_len, size_t d_len,
64     int level);
65 extern size_t gzip_compress(void *src, void *dst, size_t s_len, size_t d_len,
66     int level);
67 extern int gzip_decompress(void *src, void *dst, size_t s_len, size_t d_len,
68     int level);
69 extern size_t zle_compress(void *src, void *dst, size_t s_len, size_t d_len,
70     int level);
71 extern int zle_decompress(void *src, void *dst, size_t s_len, size_t d_len,
72     int level);
73 extern size_t lz4_compress(void *src, void *dst, size_t s_len, size_t d_len,
74     int level);
75 extern int lz4_decompress(void *src, void *dst, size_t s_len, size_t d_len,
76     int level);
77 
78 /*
79  * Compress and decompress data if necessary.
80  */
81 extern size_t zio_compress_data(enum zio_compress c, void *src, void *dst,
82     size_t s_len);
83 extern int zio_decompress_data(enum zio_compress c, void *src, void *dst,
84     size_t s_len, size_t d_len);
85 
86 #ifdef	__cplusplus
87 }
88 #endif
89 
90 #endif	/* _SYS_ZIO_COMPRESS_H */
91