sys/cddl/contrib/opensolaris/uts/common/fs/zfs/sys/zio_compress.h

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