[mirror_zfs.git] / include / sys / zio_compress.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 * Copyright (c) 2015 by Delphix. All rights reserved.
 */

#ifndef _SYS_ZIO_COMPRESS_H
#define	_SYS_ZIO_COMPRESS_H

#ifdef	__cplusplus
extern "C" {
#endif

enum zio_compress {
	ZIO_COMPRESS_INHERIT = 0,
	ZIO_COMPRESS_ON,
	ZIO_COMPRESS_OFF,
	ZIO_COMPRESS_LZJB,
	ZIO_COMPRESS_EMPTY,
	ZIO_COMPRESS_GZIP_1,
	ZIO_COMPRESS_GZIP_2,
	ZIO_COMPRESS_GZIP_3,
	ZIO_COMPRESS_GZIP_4,
	ZIO_COMPRESS_GZIP_5,
	ZIO_COMPRESS_GZIP_6,
	ZIO_COMPRESS_GZIP_7,
	ZIO_COMPRESS_GZIP_8,
	ZIO_COMPRESS_GZIP_9,
	ZIO_COMPRESS_ZLE,
	ZIO_COMPRESS_LZ4,
	ZIO_COMPRESS_FUNCTIONS
};

/* Common signature for all zio compress functions. */
typedef size_t zio_compress_func_t(void *src, void *dst,
    size_t s_len, size_t d_len, int);
/* Common signature for all zio decompress functions. */
typedef int zio_decompress_func_t(void *src, void *dst,
    size_t s_len, size_t d_len, int);

/*
 * Information about each compression function.
 */
typedef const struct zio_compress_info {
	zio_compress_func_t	*ci_compress;	/* compression function */
	zio_decompress_func_t	*ci_decompress;	/* decompression function */
	int			ci_level;	/* level parameter */
	char			*ci_name;	/* algorithm name */
} zio_compress_info_t;

extern zio_compress_info_t zio_compress_table[ZIO_COMPRESS_FUNCTIONS];

/*
 * lz4 compression init & free
 */
extern void lz4_init(void);
extern void lz4_fini(void);

/*
 * Compression routines.
 */
extern size_t lzjb_compress(void *src, void *dst, size_t s_len, size_t d_len,
    int level);
extern int lzjb_decompress(void *src, void *dst, size_t s_len, size_t d_len,
    int level);
extern size_t gzip_compress(void *src, void *dst, size_t s_len, size_t d_len,
    int level);
extern int gzip_decompress(void *src, void *dst, size_t s_len, size_t d_len,
    int level);
extern size_t zle_compress(void *src, void *dst, size_t s_len, size_t d_len,
    int level);
extern int zle_decompress(void *src, void *dst, size_t s_len, size_t d_len,
    int level);
extern size_t lz4_compress_zfs(void *src, void *dst, size_t s_len, size_t d_len,
    int level);
extern int lz4_decompress_zfs(void *src, void *dst, size_t s_len, size_t d_len,
    int level);

/*
 * Compress and decompress data if necessary.
 */
extern size_t zio_compress_data(enum zio_compress c, void *src, void *dst,
    size_t s_len);
extern int zio_decompress_data(enum zio_compress c, void *src, void *dst,
    size_t s_len, size_t d_len);

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_ZIO_COMPRESS_H */
Commit	Line	Data
34dc7c2f BB	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	/*
428870ff	23	* Copyright 2009 Sun Microsystems, Inc. All rights reserved.
34dc7c2f	24	* Use is subject to license terms.
2aa34383	25	* Copyright (c) 2015 by Delphix. All rights reserved.
34dc7c2f BB	26	*/
	27
	28	#ifndef _SYS_ZIO_COMPRESS_H
	29	#define _SYS_ZIO_COMPRESS_H
	30
34dc7c2f BB	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
2aa34383 DK	35	enum zio_compress {
	36	ZIO_COMPRESS_INHERIT = 0,
	37	ZIO_COMPRESS_ON,
	38	ZIO_COMPRESS_OFF,
	39	ZIO_COMPRESS_LZJB,
	40	ZIO_COMPRESS_EMPTY,
	41	ZIO_COMPRESS_GZIP_1,
	42	ZIO_COMPRESS_GZIP_2,
	43	ZIO_COMPRESS_GZIP_3,
	44	ZIO_COMPRESS_GZIP_4,
	45	ZIO_COMPRESS_GZIP_5,
	46	ZIO_COMPRESS_GZIP_6,
	47	ZIO_COMPRESS_GZIP_7,
	48	ZIO_COMPRESS_GZIP_8,
	49	ZIO_COMPRESS_GZIP_9,
	50	ZIO_COMPRESS_ZLE,
	51	ZIO_COMPRESS_LZ4,
	52	ZIO_COMPRESS_FUNCTIONS
	53	};
	54
d3cc8b15	55	/* Common signature for all zio compress functions. */
34dc7c2f BB	56	typedef size_t zio_compress_func_t(void src, void dst,
34dc7c2f BB	57	size_t s_len, size_t d_len, int);
d3cc8b15	58	/* Common signature for all zio decompress functions. */
34dc7c2f BB	59	typedef int zio_decompress_func_t(void src, void dst,
	60	size_t s_len, size_t d_len, int);
	61
	62	/*
	63	* Information about each compression function.
	64	*/
b01615d5	65	typedef const struct zio_compress_info {
34dc7c2f BB	66	zio_compress_func_t ci_compress; / compression function */
	67	zio_decompress_func_t ci_decompress; / decompression function */
	68	int ci_level; /* level parameter */
	69	char ci_name; / algorithm name */
	70	} zio_compress_info_t;
	71
	72	extern zio_compress_info_t zio_compress_table[ZIO_COMPRESS_FUNCTIONS];
	73
9759c60f ED	74	/*
	75	* lz4 compression init & free
	76	*/
	77	extern void lz4_init(void);
	78	extern void lz4_fini(void);
	79
34dc7c2f BB	80	/*
	81	* Compression routines.
	82	*/
	83	extern size_t lzjb_compress(void src, void dst, size_t s_len, size_t d_len,
	84	int level);
	85	extern int lzjb_decompress(void src, void dst, size_t s_len, size_t d_len,
	86	int level);
	87	extern size_t gzip_compress(void src, void dst, size_t s_len, size_t d_len,
	88	int level);
	89	extern int gzip_decompress(void src, void dst, size_t s_len, size_t d_len,
	90	int level);
428870ff BB	91	extern size_t zle_compress(void src, void dst, size_t s_len, size_t d_len,
	92	int level);
	93	extern int zle_decompress(void src, void dst, size_t s_len, size_t d_len,
	94	int level);
b3c49d3d	95	extern size_t lz4_compress_zfs(void src, void dst, size_t s_len, size_t d_len,
9759c60f	96	int level);
b3c49d3d	97	extern int lz4_decompress_zfs(void src, void dst, size_t s_len, size_t d_len,
9759c60f	98	int level);
34dc7c2f BB	99
	100	/*
	101	* Compress and decompress data if necessary.
	102	*/
428870ff BB	103	extern size_t zio_compress_data(enum zio_compress c, void src, void dst,
	104	size_t s_len);
	105	extern int zio_decompress_data(enum zio_compress c, void src, void dst,
	106	size_t s_len, size_t d_len);
34dc7c2f BB	107
	108	#ifdef __cplusplus
	109	}
	110	#endif
	111
	112	#endif /* _SYS_ZIO_COMPRESS_H */