File: gzran.c

package info (click to toggle)
erofs-utils 1.9-2
  • links: PTS
  • area: main
  • in suites:
  • size: 1,392 kB
  • sloc: ansic: 28,406; makefile: 203; sh: 33
file content (414 lines) | stat: -rw-r--r-- 10,055 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
// SPDX-License-Identifier: GPL-2.0+ OR Apache-2.0
/*
 * Copyright (C) 2025 Alibaba Cloud
 */
#include "erofs/list.h"
#include "erofs/err.h"
#include "liberofs_gzran.h"
#include <stdlib.h>
#include <zlib.h>

#ifdef HAVE_ZLIB
struct erofs_gzran_cutpoint {
	u8	window[EROFS_GZRAN_WINSIZE];	/* preceding 32K of uncompressed data */
	u64	outpos;			/* corresponding offset in uncompressed data */
	u64	in_bitpos;		/* bit offset in input file of first full byte */
};

struct erofs_gzran_cutpoint_item {
	struct erofs_gzran_cutpoint	cp;
	struct list_head		list;
};

struct erofs_gzran_builder {
	struct list_head items;
	struct erofs_vfile *vf;
	z_stream strm;
	u64 totout, totin;
	u32 entries;
	u32 span_size;
	u8 window[EROFS_GZRAN_WINSIZE];
	u8 src[1 << 14];
	bool initial;
};

struct erofs_gzran_builder *erofs_gzran_builder_init(struct erofs_vfile *vf,
						     u32 span_size)
{
	struct erofs_gzran_builder *gb;
	z_stream *strm;
	int ret;

	gb = malloc(sizeof(*gb));
	if (!gb)
		return ERR_PTR(-ENOMEM);
	strm = &gb->strm;
	/* initialize inflate */
	strm->zalloc = Z_NULL;
	strm->zfree = Z_NULL;
	strm->opaque = Z_NULL;
	strm->avail_in = 0;
	strm->next_in = Z_NULL;
	ret = inflateInit2(strm, 47);	/* automatic zlib or gzip decoding */
	if (ret != Z_OK)
		return ERR_PTR(-EFAULT);
	gb->vf = vf;
	gb->span_size = span_size;
	gb->totout = gb->totin = 0;
	gb->entries = 0;
	gb->initial = true;
	init_list_head(&gb->items);
	return gb;
}

/* return up to 32K of data at once */
int erofs_gzran_builder_read(struct erofs_gzran_builder *gb, char *window)
{
	struct erofs_gzran_cutpoint_item *ci;
	struct erofs_gzran_cutpoint *cp;
	z_stream *strm = &gb->strm;
	struct erofs_vfile *vf = gb->vf;
	int read, ret;
	u64 last;

	strm->avail_out = sizeof(gb->window);
	strm->next_out = gb->window;
	do {
		if (!strm->avail_in) {
			read = erofs_io_read(vf, gb->src, sizeof(gb->src));
			if (read <= 0)
				return read;
			strm->avail_in = read;
			strm->next_in = gb->src;
		}
		gb->totin += strm->avail_in;
		gb->totout += strm->avail_out;

		ret = inflate(strm, Z_BLOCK);	/* return at end of block */
		gb->totin -= strm->avail_in;
		gb->totout -= strm->avail_out;

		if (ret == Z_NEED_DICT)
			ret = Z_DATA_ERROR;
		if (ret == Z_MEM_ERROR || ret == Z_DATA_ERROR)
			return -EIO;
		if (ret == Z_STREAM_END) {
			inflateReset(strm);
			gb->initial = true;
			/* address concatenated gzip streams: e.g. (e)stargz */
			if (strm->avail_out < sizeof(gb->window))
				break;
			continue;
		}
		ci = list_empty(&gb->items) ? NULL :
			list_last_entry(&gb->items,
					struct erofs_gzran_cutpoint_item,
					list);
		last = ci ? ci->cp.outpos : 0;
		if ((strm->data_type & 128) && !(strm->data_type & 64) &&
		    (gb->initial || gb->totout - last > gb->span_size)) {
			ci = malloc(sizeof(*ci));
			if (!ci)
				return -ENOMEM;
			init_list_head(&ci->list);
			cp = &ci->cp;

			cp->in_bitpos = (gb->totin << 3) | (strm->data_type & 7);
			cp->outpos = gb->totout;
			read = sizeof(gb->window) - strm->avail_out;
			if (strm->avail_out)
				memcpy(cp->window, gb->window + read, strm->avail_out);
			if (read)
				memcpy(cp->window + strm->avail_out, gb->window, read);
			list_add_tail(&ci->list, &gb->items);
			gb->entries++;
			gb->initial = false;
		}
	} while (strm->avail_out);

	read = sizeof(gb->window) - strm->avail_out;
	memcpy(window, gb->window, read);
	return read;
}

struct aws_soci_zinfo_header {
	__le32 have;
	__le64 span_size;
} __packed;

struct aws_soci_zinfo_ckpt {
	__le64 in;
	__le64 out;
	__u8 bits;
	u8 window[EROFS_GZRAN_WINSIZE];
} __packed;

/* Generate AWS SOCI-compatible on-disk zinfo version 2 */
int erofs_gzran_builder_export_zinfo(struct erofs_gzran_builder *gb,
				     struct erofs_vfile *zinfo_vf)
{
	union {
		struct aws_soci_zinfo_header h;
		struct aws_soci_zinfo_ckpt c;
	} u;
	struct erofs_gzran_cutpoint_item *ci;
	u64 pos;
	int ret;

	BUILD_BUG_ON(sizeof(u.h) != 12);
	u.h = (struct aws_soci_zinfo_header) {
		.have = cpu_to_le32(gb->entries),
		.span_size = cpu_to_le64(gb->span_size),
	};
	ret = erofs_io_pwrite(zinfo_vf, &u.h, 0, sizeof(u.h));
	if (ret < 0)
		return ret;
	if (ret != sizeof(u.h))
		return -EIO;

	pos = sizeof(u.h);
	list_for_each_entry(ci, &gb->items, list) {
		BUILD_BUG_ON(sizeof(u.c) != 17 + EROFS_GZRAN_WINSIZE);
		u.c.in = cpu_to_le64(ci->cp.in_bitpos >> 3);
		u.c.out = cpu_to_le64(ci->cp.outpos);
		u.c.bits = ci->cp.in_bitpos & 7;
		memcpy(u.c.window, ci->cp.window, EROFS_GZRAN_WINSIZE);

		ret = erofs_io_pwrite(zinfo_vf, &u.c, pos, sizeof(u.c));
		if (ret < 0)
			return ret;
		if (ret != sizeof(u.c))
			return -EIO;
		pos += sizeof(u.c);
	}
	return 0;
}

int erofs_gzran_builder_final(struct erofs_gzran_builder *gb)
{
	struct erofs_gzran_cutpoint_item *ci, *n;
	int ret;

	ret = inflateEnd(&gb->strm);
	if (ret != Z_OK)
		return -EFAULT;
	list_for_each_entry_safe(ci, n, &gb->items, list) {
		list_del(&ci->list);
		free(ci);
		--gb->entries;
	}
	DBG_BUGON(gb->entries);
	free(gb);
	return 0;
}

struct erofs_gzran_iostream {
	struct erofs_vfile *vin;
	struct erofs_gzran_cutpoint *cp;
	u32 entries;
	u32 span_size;
};

static void erofs_gzran_ios_vfclose(struct erofs_vfile *vf)
{
	struct erofs_gzran_iostream *ios =
		(struct erofs_gzran_iostream *)vf->payload;
	free(ios->cp);
	free(vf);
}

static ssize_t erofs_gzran_ios_vfpread(struct erofs_vfile *vf, void *buf, size_t len, u64 offset)
{
	struct erofs_gzran_iostream *ios =
		(struct erofs_gzran_iostream *)vf->payload;
	struct erofs_gzran_cutpoint *cp = ios->cp;
	u8 src[131072], discard[EROFS_GZRAN_WINSIZE];
	union {
		unsigned int bits, i;
	} u;
	bool skip = true;
	u64 inpos, remin;
	z_stream strm;
	int ret;

	if (offset == ~0ULL) {
		DBG_BUGON(1);
		return -EIO;
	}

	while (cp[1].outpos <= offset)
		++cp;
	for (u.i = 1; cp[u.i].outpos < offset + len; ++u.i);
	remin = (cp[u.i].in_bitpos >> 3) + !!(cp[u.i].in_bitpos & 7);

	strm.zalloc = Z_NULL;
	strm.zfree = Z_NULL;
	strm.opaque = Z_NULL;
	strm.avail_in = 0;
	strm.next_in = Z_NULL;
	ret = inflateInit2(&strm, -15);		/* raw inflate */
	if (ret != Z_OK)
		return -EFAULT;

	u.bits = cp->in_bitpos & 7;
	inpos = (cp->in_bitpos >> 3) - (u.bits ? 1 : 0);
	remin -= inpos;
	ret = erofs_io_pread(ios->vin, src,
			     min(remin, (u64)sizeof(src)), inpos);
	if (ret < 0)
		return ret;
	if (u.bits) {
		inflatePrime(&strm, u.bits, src[0] >> (8 - u.bits));
		strm.next_in = src + 1;
		strm.avail_in = ret - 1;
	} else {
		strm.next_in = src;
		strm.avail_in = ret;
	}
	remin -= ret;
	inpos += ret;
	(void)inflateSetDictionary(&strm, cp->window, sizeof(cp->window));

	offset -= cp->outpos;
	do {
		/* define where to put uncompressed data, and how much */
		if (!offset && skip) {          /* at offset now */
			strm.avail_out = len;
			strm.next_out = buf;
			skip = false;		/* only do this once */
		} else if (offset > sizeof(discard)) {	/* skip WINSIZE bytes */
			strm.avail_out = sizeof(discard);
			strm.next_out = discard;
			offset -= sizeof(discard);
		} else if (offset) {			/* last skip */
			strm.avail_out = (unsigned int)offset;
			strm.next_out = discard;
			offset = 0;
		}

		/* uncompress until avail_out filled, or end of stream */
		do {
			if (!strm.avail_in) {
				ret = erofs_io_pread(ios->vin, src,
						     min(remin, (u64)sizeof(src)),
						     inpos);
				if (ret < 0)
					return ret;
				if (!ret)
					return -EIO;
				inpos += ret;
				remin -= ret;
				strm.avail_in = ret;
				strm.next_in = src;
			}
			ret = inflate(&strm, Z_NO_FLUSH);       /* normal inflate */
			if (ret == Z_NEED_DICT)
				ret = Z_DATA_ERROR;
			if (ret == Z_MEM_ERROR || ret == Z_DATA_ERROR)
				return -EIO;
			if (ret == Z_STREAM_END)
				break;
		} while (strm.avail_out);

		/* if reach end of stream, then don't keep trying to get more */
		if (ret == Z_STREAM_END)
			break;

		/* do until offset reached and requested data read, or stream ends */
	} while (skip);
	return len - strm.avail_out;
}

static struct erofs_vfops erofs_gzran_ios_vfops = {
	.pread = erofs_gzran_ios_vfpread,
	.close = erofs_gzran_ios_vfclose,
};

struct erofs_vfile *erofs_gzran_zinfo_open(struct erofs_vfile *vin,
					   void *zinfo_buf, unsigned int len)
{
	struct aws_soci_zinfo_header *h;
	struct aws_soci_zinfo_ckpt *c;
	struct erofs_vfile *vf;
	struct erofs_gzran_iostream *ios;
	unsigned int v2_size, version;
	int ret, i;

	if (len && len < sizeof(*h))
		return ERR_PTR(-EINVAL);

	vf = malloc(sizeof(*vf) + sizeof(*ios));
	if (!vf)
		return ERR_PTR(-ENOMEM);

	ios = (struct erofs_gzran_iostream *)vf->payload;
	h = zinfo_buf;
	ios->entries = le32_to_cpu(h->have);
	ios->span_size = le32_to_cpu(h->span_size);

	v2_size = sizeof(*c) * ios->entries + sizeof(*h);
	if (!len || v2_size == len) {
		version = 2;
	} else if (v2_size - sizeof(*c) == len) {
		version = 1;
	} else {
		ret = -EOPNOTSUPP;
		goto err_ios;
	}

	ios->cp = malloc(sizeof(*ios->cp) * (ios->entries + 1));
	if (!ios->cp) {
		ret = -ENOMEM;
		goto err_ios;
	}

	i = 0;
	if (version == 1) {
		ios->cp[0] = (struct erofs_gzran_cutpoint) {
			.in_bitpos = 10 << 3,
			.outpos = 0,
		};
		i = 1;
	}

	c = (struct aws_soci_zinfo_ckpt *)(h + 1);
	for (; i < ios->entries; ++i, ++c) {
		ios->cp[i].in_bitpos = (le64_to_cpu(c->in) << 3) | c->bits;
		ios->cp[i].outpos = le64_to_cpu(c->out);
		memcpy(ios->cp[i].window, c->window, sizeof(c->window));
	}
	ios->cp[i].in_bitpos = -1;
	ios->cp[i].outpos = ~0ULL;
	ios->vin = vin;
	vf->ops = &erofs_gzran_ios_vfops;
	return vf;
err_ios:
	free(vf);
	return ERR_PTR(ret);
}
#else
struct erofs_gzran_builder *erofs_gzran_builder_init(struct erofs_vfile *vf,
						     u32 span_size)
{
	return ERR_PTR(-EOPNOTSUPP);
}
int erofs_gzran_builder_read(struct erofs_gzran_builder *gb, char *window)
{
	return 0;
}
int erofs_gzran_builder_export_zinfo(struct erofs_gzran_builder *gb,
				     struct erofs_vfile *zinfo_vf)
{
	return -EOPNOTSUPP;
}
int erofs_gzran_builder_final(struct erofs_gzran_builder *gb)
{
	return 0;
}

struct erofs_vfile *erofs_gzran_zinfo_open(struct erofs_vfile *vin,
					   void *zinfo_buf, unsigned int len)
{
	return ERR_PTR(-EOPNOTSUPP);
}
#endif