opnsense-src/sys/sys/compressor.h
Kyle Evans 088fdf8fb8 kern: add a compressor_format() accessor to the compresssor API
Some work in progress on the ucoredump bits (D51377) would pass the
compression format out-of-band to the coredump writer's init function,
but the compressor is accessible to the init_fn via the coredump_params.

Making this accessible in parts of the kernel detached from the bits
actually doing compression would be useful to clean up the API so that
we can stick to using coredump_params to pass along whatever may be
useful.

Reviewed by:	markj
Differential Revision:	https://reviews.freebsd.org/D51561
2025-07-26 16:31:42 -05:00

53 lines
2.1 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2014, 2017 Mark Johnston <markj@FreeBSD.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#ifndef _SYS__COMPRESSOR_H_
#define _SYS__COMPRESSOR_H_
#ifdef _KERNEL
/* Supported formats. */
#define COMPRESS_GZIP 1
#define COMPRESS_ZSTD 2
typedef int (*compressor_cb_t)(void *, size_t, off_t, void *);
struct compressor;
bool compressor_avail(int format);
struct compressor *compressor_init(compressor_cb_t cb, int format,
size_t maxiosize, int level, void *arg);
int compressor_format(const struct compressor *stream);
void compressor_reset(struct compressor *stream);
int compressor_write(struct compressor *stream, void *data,
size_t len);
int compressor_flush(struct compressor *stream);
void compressor_fini(struct compressor *stream);
#endif /* _KERNEL */
#endif /* _SYS__COMPRESSOR_H_ */