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