604e65334e
The Zstd format bumps the CLOOP major number to 4 to avoid incompatibility
with older systems. Support in geom_uzip(4) is conditional on the ZSTDIO
kernel option, which is enabled in amd64 GENERIC, but not all in-tree
configurations.
mkuzip(8) was modified slightly to always initialize the nblocks + 1'th
offset in the CLOOP file format. Previously, it was only initialized in the
case where the final compressed block happened to be unaligned w.r.t.
DEV_BSIZE. The "Fake" last+1 block change in r298619 means that the final
compressed block's 'blen' was never correct unless the compressed uzip image
happened to be BSIZE-aligned. This happened in about 1 out of every 512
cases. The zlib and lzma decompressors are probably tolerant of extra trash
following the frame they were told to decode, but Zstd complains that the
input size is incorrect.
Correspondingly, geom_uzip(4) was modified slightly to avoid trashing the
nblocks + 1'th offset when it is known to be initialized to a good value.
This corrects the calculated final real cluster compressed length to match
that printed by mkuzip(8).
mkuzip(8) was refactored somewhat to reduce code duplication and increase
ease of adding other compression formats.
* Input block size validation was pulled out of individual compression
init routines into main().
* Init routines now validate a user-provided compression level or select
an algorithm-specific default, if none was provided.
* A new interface for calculating the maximal compressed size of an
incompressible input block was added for each driver. The generic code
uses it to validate against MAXPHYS as well as to allocate compression
result buffers in the generic code.
* Algorithm selection is now driven by a table lookup, to increase ease of
adding other formats in the future.
mkuzip(8) gained the ability to explicitly specify a compression level with
'-C'. The prior defaults -- 9 for zlib and 6 for lzma -- are maintained.
The new zstd default is 9, to match zlib.
Rather than select lzma or zlib with '-L' or its absense, respectively, a
new argument '-A <algorithm>' is provided to select 'zlib', 'lzma', or
'zstd'. '-L' is considered deprecated, but will probably never be removed.
All of the new features were documented in mkuzip.8; the page was also
cleaned up slightly.
Relnotes: yes
96 lines
2.8 KiB
C
96 lines
2.8 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
*
|
|
* Copyright (c) 2019 Conrad Meyer <cem@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.
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
#include <err.h>
|
|
#include <limits.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#include <zstd.h>
|
|
|
|
#include "mkuzip.h"
|
|
#include "mkuz_blk.h"
|
|
#include "mkuz_zstd.h"
|
|
|
|
size_t
|
|
mkuz_zstd_cbound(size_t blksz)
|
|
{
|
|
return (ZSTD_compressBound(blksz));
|
|
}
|
|
|
|
void *
|
|
mkuz_zstd_init(int *comp_level)
|
|
{
|
|
ZSTD_CCtx *cctx;
|
|
size_t rc;
|
|
|
|
/* Default chosen for near-parity with mkuzip zlib default. */
|
|
if (*comp_level == USE_DEFAULT_LEVEL)
|
|
*comp_level = 9;
|
|
if (*comp_level < ZSTD_minCLevel() || *comp_level == 0 ||
|
|
*comp_level > ZSTD_maxCLevel())
|
|
errx(1, "provided compression level %d is invalid",
|
|
*comp_level);
|
|
|
|
cctx = ZSTD_createCCtx();
|
|
if (cctx == NULL)
|
|
errx(1, "could not allocate Zstd context");
|
|
|
|
rc = ZSTD_CCtx_setParameter(cctx, ZSTD_c_compressionLevel,
|
|
*comp_level);
|
|
if (ZSTD_isError(rc))
|
|
errx(1, "Could not set zstd compression level %d: %s",
|
|
*comp_level, ZSTD_getErrorName(rc));
|
|
|
|
rc = ZSTD_CCtx_setParameter(cctx, ZSTD_c_checksumFlag, 1);
|
|
if (ZSTD_isError(rc))
|
|
errx(1, "Could not enable zstd checksum: %s",
|
|
ZSTD_getErrorName(rc));
|
|
|
|
return (cctx);
|
|
}
|
|
|
|
void
|
|
mkuz_zstd_compress(void *p, const struct mkuz_blk *iblk, struct mkuz_blk *oblk)
|
|
{
|
|
ZSTD_CCtx *cctx;
|
|
size_t rc;
|
|
|
|
cctx = p;
|
|
|
|
rc = ZSTD_compress2(cctx, oblk->data, oblk->alen, iblk->data,
|
|
iblk->info.len);
|
|
if (ZSTD_isError(rc))
|
|
errx(1, "could not compress data: ZSTD_compress2: %s",
|
|
ZSTD_getErrorName(rc));
|
|
|
|
oblk->info.len = rc;
|
|
}
|