]> git.proxmox.com Git - mirror_zfs.git/blame - include/sys/zio_compress.h
Add CODE_OF_CONDUCT.md
[mirror_zfs.git] / include / sys / zio_compress.h
CommitLineData
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.
a6255b7f 25 * Copyright (c) 2015, 2016 by Delphix. All rights reserved.
34dc7c2f
BB
26 */
27
28#ifndef _SYS_ZIO_COMPRESS_H
29#define _SYS_ZIO_COMPRESS_H
30
a6255b7f
DQ
31#include <sys/abd.h>
32
34dc7c2f
BB
33#ifdef __cplusplus
34extern "C" {
35#endif
36
2aa34383
DK
37enum zio_compress {
38 ZIO_COMPRESS_INHERIT = 0,
39 ZIO_COMPRESS_ON,
40 ZIO_COMPRESS_OFF,
41 ZIO_COMPRESS_LZJB,
42 ZIO_COMPRESS_EMPTY,
43 ZIO_COMPRESS_GZIP_1,
44 ZIO_COMPRESS_GZIP_2,
45 ZIO_COMPRESS_GZIP_3,
46 ZIO_COMPRESS_GZIP_4,
47 ZIO_COMPRESS_GZIP_5,
48 ZIO_COMPRESS_GZIP_6,
49 ZIO_COMPRESS_GZIP_7,
50 ZIO_COMPRESS_GZIP_8,
51 ZIO_COMPRESS_GZIP_9,
52 ZIO_COMPRESS_ZLE,
53 ZIO_COMPRESS_LZ4,
54 ZIO_COMPRESS_FUNCTIONS
55};
56
d3cc8b15 57/* Common signature for all zio compress functions. */
34dc7c2f
BB
58typedef size_t zio_compress_func_t(void *src, void *dst,
59 size_t s_len, size_t d_len, int);
d3cc8b15 60/* Common signature for all zio decompress functions. */
34dc7c2f
BB
61typedef int zio_decompress_func_t(void *src, void *dst,
62 size_t s_len, size_t d_len, int);
63
a6255b7f
DQ
64/*
65 * Common signature for all zio decompress functions using an ABD as input.
66 * This is helpful if you have both compressed ARC and scatter ABDs enabled,
67 * but is not a requirement for all compression algorithms.
68 */
69typedef int zio_decompress_abd_func_t(abd_t *src, void *dst,
70 size_t s_len, size_t d_len, int);
34dc7c2f
BB
71/*
72 * Information about each compression function.
73 */
b01615d5 74typedef const struct zio_compress_info {
a6255b7f
DQ
75 char *ci_name;
76 int ci_level;
77 zio_compress_func_t *ci_compress;
78 zio_decompress_func_t *ci_decompress;
34dc7c2f
BB
79} zio_compress_info_t;
80
81extern zio_compress_info_t zio_compress_table[ZIO_COMPRESS_FUNCTIONS];
82
9759c60f
ED
83/*
84 * lz4 compression init & free
85 */
86extern void lz4_init(void);
87extern void lz4_fini(void);
88
34dc7c2f
BB
89/*
90 * Compression routines.
91 */
92extern size_t lzjb_compress(void *src, void *dst, size_t s_len, size_t d_len,
93 int level);
94extern int lzjb_decompress(void *src, void *dst, size_t s_len, size_t d_len,
95 int level);
96extern size_t gzip_compress(void *src, void *dst, size_t s_len, size_t d_len,
97 int level);
98extern int gzip_decompress(void *src, void *dst, size_t s_len, size_t d_len,
99 int level);
428870ff
BB
100extern size_t zle_compress(void *src, void *dst, size_t s_len, size_t d_len,
101 int level);
102extern int zle_decompress(void *src, void *dst, size_t s_len, size_t d_len,
103 int level);
b3c49d3d 104extern size_t lz4_compress_zfs(void *src, void *dst, size_t s_len, size_t d_len,
9759c60f 105 int level);
b3c49d3d 106extern int lz4_decompress_zfs(void *src, void *dst, size_t s_len, size_t d_len,
9759c60f 107 int level);
a6255b7f
DQ
108extern int lz4_decompress_abd(abd_t *src, void *dst, size_t s_len, size_t d_len,
109 int level);
34dc7c2f
BB
110/*
111 * Compress and decompress data if necessary.
112 */
a6255b7f 113extern size_t zio_compress_data(enum zio_compress c, abd_t *src, void *dst,
428870ff 114 size_t s_len);
a6255b7f
DQ
115extern int zio_decompress_data(enum zio_compress c, abd_t *src, void *dst,
116 size_t s_len, size_t d_len);
117extern int zio_decompress_data_buf(enum zio_compress c, void *src, void *dst,
428870ff 118 size_t s_len, size_t d_len);
34dc7c2f
BB
119
120#ifdef __cplusplus
121}
122#endif
123
124#endif /* _SYS_ZIO_COMPRESS_H */