sys/sys/compressor.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2014, 2017 Mark Johnston <markj@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _SYS__COMPRESSOR_H_
  32 #define _SYS__COMPRESSOR_H_
  33
  34 #ifdef _KERNEL
  35
  36 /* Supported formats. */
  37 #define COMPRESS_GZIP   1
  38 #define COMPRESS_ZSTD   2
  39
  40 typedef int (*compressor_cb_t)(void *, size_t, off_t, void *);
  41
  42 struct compressor;
  43
  44 bool            compressor_avail(int format);
  45 struct compressor *compressor_init(compressor_cb_t cb, int format,
  46                     size_t maxiosize, int level, void *arg);
  47 void            compressor_reset(struct compressor *stream);
  48 int             compressor_write(struct compressor *stream, void *data,
  49                     size_t len);
  50 int             compressor_flush(struct compressor *stream);
  51 void            compressor_fini(struct compressor *stream);
  52
  53 #endif /* _KERNEL */
  54 #endif /* _SYS__COMPRESSOR_H_ */