include/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 #ifndef _SYS_ZIO_COMPRESS_H
  28 #define _SYS_ZIO_COMPRESS_H
  29
  30 #include <sys/zio.h>
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /*
  37  * Common signature for all zio compress/decompress functions.
  38  */
  39 typedef size_t zio_compress_func_t(void *src, void *dst,
  40     size_t s_len, size_t d_len, int);
  41 typedef int zio_decompress_func_t(void *src, void *dst,
  42     size_t s_len, size_t d_len, int);
  43
  44 /*
  45  * Information about each compression function.
  46  */
  47 typedef const struct zio_compress_info {
  48         zio_compress_func_t     *ci_compress;   /* compression function */
  49         zio_decompress_func_t   *ci_decompress; /* decompression function */
  50         int                     ci_level;       /* level parameter */
  51         char                    *ci_name;       /* algorithm name */
  52 } zio_compress_info_t;
  53
  54 extern zio_compress_info_t zio_compress_table[ZIO_COMPRESS_FUNCTIONS];
  55
  56 /*
  57  * lz4 compression init & free
  58  */
  59 extern void lz4_init(void);
  60 extern void lz4_fini(void);
  61
  62 /*
  63  * Compression routines.
  64  */
  65 extern size_t lzjb_compress(void *src, void *dst, size_t s_len, size_t d_len,
  66     int level);
  67 extern int lzjb_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  68     int level);
  69 extern size_t gzip_compress(void *src, void *dst, size_t s_len, size_t d_len,
  70     int level);
  71 extern int gzip_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  72     int level);
  73 extern size_t zle_compress(void *src, void *dst, size_t s_len, size_t d_len,
  74     int level);
  75 extern int zle_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  76     int level);
  77 extern size_t lz4_compress(void *src, void *dst, size_t s_len, size_t d_len,
  78     int level);
  79 extern int lz4_decompress(void *src, void *dst, size_t s_len, size_t d_len,
  80     int level);
  81
  82 /*
  83  * Compress and decompress data if necessary.
  84  */
  85 extern size_t zio_compress_data(enum zio_compress c, void *src, void *dst,
  86     size_t s_len);
  87 extern int zio_decompress_data(enum zio_compress c, void *src, void *dst,
  88     size_t s_len, size_t d_len);
  89
  90 #ifdef  __cplusplus
  91 }
  92 #endif
  93
  94 #endif  /* _SYS_ZIO_COMPRESS_H */