xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zio_compress.h (revision a6f561b4aee75d0d028e7b36b151c8ed8a86bc76)
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 /*
40  * Common signature for all zio compress/decompress functions.
41  */
42 typedef size_t zio_compress_func_t(void *src, void *dst,
43     size_t s_len, size_t d_len, int);
44 typedef int zio_decompress_func_t(void *src, void *dst,
45     size_t s_len, size_t d_len, int);
46 
47 /*
48  * Information about each compression function.
49  */
50 typedef struct zio_compress_info {
51 	zio_compress_func_t	*ci_compress;	/* compression function */
52 	zio_decompress_func_t	*ci_decompress;	/* decompression function */
53 	int			ci_level;	/* level parameter */
54 	char			*ci_name;	/* algorithm name */
55 } zio_compress_info_t;
56 
57 extern zio_compress_info_t zio_compress_table[ZIO_COMPRESS_FUNCTIONS];
58 
59 /*
60  * Compression routines.
61  */
62 extern size_t lzjb_compress(void *src, void *dst, size_t s_len, size_t d_len,
63     int level);
64 extern int lzjb_decompress(void *src, void *dst, size_t s_len, size_t d_len,
65     int level);
66 extern size_t gzip_compress(void *src, void *dst, size_t s_len, size_t d_len,
67     int level);
68 extern int gzip_decompress(void *src, void *dst, size_t s_len, size_t d_len,
69     int level);
70 extern size_t zle_compress(void *src, void *dst, size_t s_len, size_t d_len,
71     int level);
72 extern int zle_decompress(void *src, void *dst, size_t s_len, size_t d_len,
73     int level);
74 extern size_t lz4_compress(void *src, void *dst, size_t s_len, size_t d_len,
75     int level);
76 extern int lz4_decompress(void *src, void *dst, size_t s_len, size_t d_len,
77     int level);
78 
79 /*
80  * Compress and decompress data if necessary.
81  */
82 extern size_t zio_compress_data(enum zio_compress c, void *src, void *dst,
83     size_t s_len);
84 extern int zio_decompress_data(enum zio_compress c, void *src, void *dst,
85     size_t s_len, size_t d_len);
86 
87 #ifdef	__cplusplus
88 }
89 #endif
90 
91 #endif	/* _SYS_ZIO_COMPRESS_H */
92