1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2019 Conrad Meyer <cem@FreeBSD.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are 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 the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28 #include <sys/param.h>
29 #include <sys/systm.h>
30 #include <sys/errno.h>
31 #include <sys/kernel.h>
32 #include <sys/malloc.h>
33 #include <sys/sysctl.h>
34
35 #include <geom/uzip/g_uzip.h>
36 #include <geom/uzip/g_uzip_dapi.h>
37 #include <geom/uzip/g_uzip_zstd.h>
38
39 /*
40 * We don't actually need any static-link ABI, just want to use "experimental"
41 * custom malloc/free APIs.
42 */
43 #define ZSTD_STATIC_LINKING_ONLY
44 #include <contrib/zstd/lib/zstd.h>
45
46 FEATURE(geom_uzip_zstd, "g_uzip Zstd support");
47
48 struct g_uzip_zstd {
49 struct g_uzip_dapi guz_pub;
50 uint32_t guz_blksz;
51 ZSTD_DCtx *guz_dctx;
52 };
53
54 #ifndef container_of
55 #define container_of(ptr, type, member) \
56 ({ \
57 const __typeof(((type *)0)->member) *__p = (ptr); \
58 (type *)((uintptr_t)__p - offsetof(type, member)); \
59 })
60 #endif
61 #define to_zstd_softc(zpp) container_of(zpp, struct g_uzip_zstd, guz_pub)
62
63 static int
guz_zstd_decompress(struct g_uzip_dapi * zpp,const char * gp_name,void * input,size_t ilen,void * outputbuf)64 guz_zstd_decompress(struct g_uzip_dapi *zpp, const char *gp_name, void *input,
65 size_t ilen, void *outputbuf)
66 {
67 struct g_uzip_zstd *sc;
68 size_t rc;
69
70 sc = to_zstd_softc(zpp);
71 rc = ZSTD_decompressDCtx(sc->guz_dctx, outputbuf, sc->guz_blksz, input,
72 ilen);
73 if (ZSTD_isError(rc)) {
74 printf("%s: UZIP(zstd) decompress failed: %s\n", gp_name,
75 ZSTD_getErrorName(rc));
76 return (EIO);
77 }
78 KASSERT(rc == sc->guz_blksz, ("%s: Expected %u bytes, got %zu",
79 __func__, sc->guz_blksz, rc));
80 return (0);
81 }
82
83 static void
guz_zstd_free(struct g_uzip_dapi * zpp)84 guz_zstd_free(struct g_uzip_dapi *zpp)
85 {
86 struct g_uzip_zstd *sc;
87 size_t rc;
88
89 sc = to_zstd_softc(zpp);
90 rc = ZSTD_freeDCtx(sc->guz_dctx);
91 if (ZSTD_isError(rc))
92 printf("%s: UZIP(zstd) free failed: %s\n", __func__,
93 ZSTD_getErrorName(rc));
94
95 free(sc, M_GEOM_UZIP);
96 }
97
98 static int
guz_zstd_rewind(struct g_uzip_dapi * zpp,const char * gp_name)99 guz_zstd_rewind(struct g_uzip_dapi *zpp, const char *gp_name)
100 {
101 struct g_uzip_zstd *sc;
102 size_t rc;
103
104 sc = to_zstd_softc(zpp);
105 rc = ZSTD_DCtx_reset(sc->guz_dctx, ZSTD_reset_session_and_parameters);
106 if (ZSTD_isError(rc)) {
107 printf("%s: UZIP(zstd) rewind failed: %s\n", gp_name,
108 ZSTD_getErrorName(rc));
109 return (EIO);
110 }
111 return (0);
112 }
113
114 static void *
zstd_alloc(void * opaque,size_t size)115 zstd_alloc(void *opaque, size_t size)
116 {
117 return (malloc(size, opaque, M_WAITOK));
118 }
119
120 static void
zstd_free(void * opaque,void * address)121 zstd_free(void *opaque, void *address)
122 {
123 free(address, opaque);
124 }
125
126 static const ZSTD_customMem zstd_guz_alloc = {
127 .customAlloc = zstd_alloc,
128 .customFree = zstd_free,
129 .opaque = M_GEOM_UZIP,
130 };
131
132 struct g_uzip_dapi *
g_uzip_zstd_ctor(uint32_t blksz)133 g_uzip_zstd_ctor(uint32_t blksz)
134 {
135 struct g_uzip_zstd *sc;
136
137 sc = malloc(sizeof(*sc), M_GEOM_UZIP, M_WAITOK | M_ZERO);
138
139 sc->guz_dctx = ZSTD_createDCtx_advanced(zstd_guz_alloc);
140 if (sc->guz_dctx == NULL) {
141 printf("%s: ZSTD_createDCtx_advanced failed\n", __func__);
142 free(sc, M_GEOM_UZIP);
143 return (NULL);
144 }
145
146 sc->guz_blksz = blksz;
147 sc->guz_pub.max_blen = ZSTD_compressBound(blksz);
148 sc->guz_pub.decompress = guz_zstd_decompress;
149 sc->guz_pub.free = guz_zstd_free;
150 sc->guz_pub.rewind = guz_zstd_rewind;
151 sc->guz_pub.pvt = NULL;
152
153 return (&sc->guz_pub);
154 }
155