summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/util/ioprocsfilter.cpp
blob: da67b8c41f20d6f7a103d2cf8c07c9f33cf4cb3e (plain) (blame)
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
// license:BSD-3-Clause
// copyright-holders:Vas Crabb
/***************************************************************************

    ioprocs.h

    I/O filters

***************************************************************************/

#include "ioprocsfilter.h"

#include "ioprocs.h"

#include <zlib.h>

#include <algorithm>
#include <cassert>
#include <cerrno>
#include <cstdint>
#include <limits>
#include <system_error>
#include <type_traits>
#include <utility>


namespace util {

namespace {

// helper class for holding zlib data

class zlib_data
{
protected:
	zlib_data(std::size_t buffer_size) noexcept :
		m_buffer_size(std::min<std::common_type_t<uInt, std::size_t> >(std::numeric_limits<uInt>::max(), buffer_size))
	{
		assert(buffer_size);
	}

	z_stream &get_z_stream() noexcept { return m_z_stream; }
	z_stream const &get_z_stream() const noexcept { return m_z_stream; }
	Bytef *get_buffer() noexcept { return m_buffer.get(); }
	Bytef const *get_buffer() const noexcept { return m_buffer.get(); }
	std::size_t get_buffer_size() const noexcept { return m_buffer_size; }

	bool input_empty() const noexcept { return !m_z_stream.avail_in; }
	bool output_available() const noexcept { return bool(m_z_stream.avail_out); }

	void initialize_z_stream() noexcept
	{
		m_z_stream.zalloc = Z_NULL;
		m_z_stream.zfree = Z_NULL;
		m_z_stream.opaque = Z_NULL;
	}

	std::error_condition allocate_buffer() noexcept
	{
		if (!m_buffer)
			m_buffer.reset(new (std::nothrow) Bytef [m_buffer_size]);
		return m_buffer ? std::error_condition() : std::errc::not_enough_memory;
	}

	void release_buffer() noexcept
	{
		m_buffer.reset();
	}

	static std::error_condition convert_z_error(int err) noexcept
	{
		switch (err)
		{
		case Z_OK:
		case Z_STREAM_END:
			return std::error_condition();
		case Z_NEED_DICT:
			return std::errc::invalid_argument;
		case Z_ERRNO:
			return std::error_condition(errno, std::generic_category());
		case Z_STREAM_ERROR:
			return std::errc::invalid_argument;
		case Z_DATA_ERROR:
			return std::errc::invalid_argument; // TODO: revisit this error code
		case Z_MEM_ERROR:
			return std::errc::not_enough_memory;
		case Z_BUF_ERROR:
			return std::errc::operation_would_block; // TODO: revisit this error code (should be handled internally)
		case Z_VERSION_ERROR:
			return std::errc::invalid_argument; // TODO: revisit this error code (library ABI mismatch)
		default:
			return std::errc::io_error; // TODO: better default error code
		}
	}

private:
	z_stream m_z_stream;
	std::unique_ptr<Bytef []> m_buffer;
	std::size_t const m_buffer_size;
};


// helper class for decompressing deflated data

class inflate_data : private zlib_data
{
protected:
	using zlib_data::zlib_data;

	~inflate_data()
	{
		if (m_inflate_initialized)
			inflateEnd(&get_z_stream());
	}

	using zlib_data::input_empty;

	bool stream_initialized() const noexcept
	{
		return m_inflate_initialized;
	}

	std::error_condition initialize_z_stream() noexcept
	{
		if (m_inflate_initialized)
			return std::errc::invalid_argument;
		std::error_condition err = allocate_buffer();
		if (err)
			return err;
		zlib_data::initialize_z_stream();
		int const zerr = inflateInit(&get_z_stream());
		if (Z_OK == zerr)
			m_inflate_initialized = true;
		return convert_z_error(zerr);
	}

	std::error_condition close_z_stream() noexcept
	{
		if (!m_inflate_initialized)
			return std::errc::invalid_argument;
		int const zerr = inflateEnd(&get_z_stream());
		m_inflate_initialized = false;
		return convert_z_error(zerr);
	}

	std::error_condition decompress_some(bool &stream_end) noexcept
	{
		assert(m_inflate_initialized);
		int const zerr = inflate(&get_z_stream(), Z_SYNC_FLUSH);
		if (!get_z_stream().avail_in)
			reset_input();
		stream_end = Z_STREAM_END == zerr;
		return convert_z_error(zerr);
	}

	std::size_t input_available() const noexcept
	{
		return std::size_t(get_z_stream().avail_in);
	}

	void reset_input() noexcept
	{
		get_z_stream().next_in = get_buffer();
		get_z_stream().avail_in = 0U;
	}

	std::pair<void *, std::size_t> get_unfilled_input() noexcept
	{
		assert(get_buffer());
		Bytef *const base = get_z_stream().next_in + get_z_stream().avail_in;
		return std::make_pair(base, get_buffer() + get_buffer_size() - base);
	}

	void add_input(std::size_t length) noexcept
	{
		assert(get_buffer());
		get_z_stream().avail_in += length;
		assert((get_buffer() + get_buffer_size()) >= (get_z_stream().next_in + get_z_stream().avail_in));
	}

	std::size_t output_produced() const noexcept
	{
		return m_output_max - get_z_stream().avail_out;
	}

	void set_output(void *buffer, std::size_t length) noexcept
	{
		m_output_max = std::min<std::common_type_t<uInt, std::size_t> >(std::numeric_limits<uInt>::max(), length);
		get_z_stream().next_out = reinterpret_cast<Bytef *>(buffer);
		get_z_stream().avail_out = uInt(m_output_max);
	}

private:
	std::error_condition allocate_buffer() noexcept
	{
		std::error_condition err;
		if (!get_buffer())
		{
			err = zlib_data::allocate_buffer();
			reset_input();
		}
		return err;
	}

	bool m_inflate_initialized = false;
	std::size_t m_output_max = 0U;
};


// helper class for deflating data

class deflate_data : private zlib_data
{
protected:
	deflate_data(int level, std::size_t buffer_size) noexcept : zlib_data(buffer_size), m_level(level)
	{
	}

	~deflate_data()
	{
		if (m_deflate_initialized)
			deflateEnd(&get_z_stream());
	}

	using zlib_data::input_empty;
	using zlib_data::output_available;

	bool stream_initialized() const noexcept
	{
		return m_deflate_initialized;
	}

	bool compression_finished() const noexcept
	{
		return m_compression_finished;
	}

	std::error_condition initialize_z_stream() noexcept
	{
		if (m_deflate_initialized)
			return std::errc::invalid_argument;
		std::error_condition err = allocate_buffer();
		if (err)
			return err;
		zlib_data::initialize_z_stream();
		int const zerr = deflateInit(&get_z_stream(), m_level);
		reset_output();
		if (Z_OK == zerr)
			m_deflate_initialized = true;
		return convert_z_error(zerr);
	}

	std::error_condition close_z_stream() noexcept
	{
		if (!m_deflate_initialized)
			return std::errc::invalid_argument;
		m_deflate_initialized = m_compression_finished = false;
		return convert_z_error(deflateEnd(&get_z_stream()));
	}

	std::error_condition reset_z_stream() noexcept
	{
		if (!m_deflate_initialized)
			return std::errc::invalid_argument;
		assert(get_buffer());
		reset_output();
		m_compression_finished = false;
		return convert_z_error(deflateReset(&get_z_stream()));
	}

	std::error_condition compress_some() noexcept
	{
		assert(m_deflate_initialized);
		return convert_z_error(deflate(&get_z_stream(), Z_NO_FLUSH));
	}

	std::error_condition finish_compression() noexcept
	{
		assert(m_deflate_initialized);
		int const zerr = deflate(&get_z_stream(), Z_FINISH);
		if (Z_STREAM_END == zerr)
			m_compression_finished = true;
		return convert_z_error(zerr);
	}

	std::size_t input_used() const noexcept
	{
		return m_input_max - get_z_stream().avail_in;
	}

	void set_input(void const *data, std::size_t length) noexcept
	{
		m_input_max = std::min<std::common_type_t<uInt, std::size_t> >(std::numeric_limits<uInt>::max(), length);
		get_z_stream().next_in = const_cast<Bytef z_const *>(reinterpret_cast<Bytef const *>(data));
		get_z_stream().avail_in = uInt(m_input_max);
	}

	std::pair<void const *, std::size_t> get_output() const noexcept
	{
		assert(get_buffer());
		return std::make_pair(
				&get_buffer()[m_output_used],
				get_buffer_size() - get_z_stream().avail_out - m_output_used);
	}

	void consume_output(std::size_t length) noexcept
	{
		m_output_used += length;
		assert(m_output_used <= (get_buffer_size() - get_z_stream().avail_out));
		if (m_output_used == (get_buffer_size() - get_z_stream().avail_out))
			reset_output();
	}

private:
	void reset_output() noexcept
	{
		assert(get_buffer());
		m_output_used = 0U;
		get_z_stream().next_out = get_buffer();
		get_z_stream().avail_out = uInt(get_buffer_size());
	}

	int const m_level;
	bool m_deflate_initialized = false;
	bool m_compression_finished = false;
	std::size_t m_output_used = 0U;
	std::size_t m_input_max = 0U;
};


// helper for holding an object and deleting it (or not) as necessary

template <typename T>
class filter_base
{
protected:
	filter_base(std::unique_ptr<T> &&object) noexcept : m_object(object.release()), m_owned(true)
	{
		assert(m_object);
	}

	filter_base(T &object) noexcept : m_object(&object), m_owned(false)
	{
	}

	~filter_base()
	{
		if (m_owned)
			delete m_object;
	}

	T &object() noexcept
	{
		return *m_object;
	}

private:
	T *const m_object;
	bool const m_owned;
};


// filter for decompressing deflated data

template <typename Stream>
class zlib_read_filter : public read_stream, protected filter_base<Stream>, protected inflate_data
{
public:
	zlib_read_filter(std::unique_ptr<Stream> &&stream, std::size_t read_chunk) noexcept :
		filter_base<Stream>(std::move(stream)),
		inflate_data(read_chunk)
	{
	}

	zlib_read_filter(Stream &stream, std::size_t read_chunk) noexcept :
		filter_base<Stream>(stream),
		inflate_data(read_chunk)
	{
	}

	virtual std::error_condition read(void *buffer, std::size_t length, std::size_t &actual) noexcept override
	{
		std::error_condition err;
		actual = 0U;

		if (!stream_initialized())
			err = initialize_z_stream();

		if (!err && (length > actual))
		{
			bool short_input = false;
			do
			{
				if (input_empty())
				{
					auto const space = get_unfilled_input();
					std::size_t filled;
					err = this->object().read(space.first, space.second, filled);
					add_input(filled);
					short_input = space.second > filled;
				}

				if (!err && !input_empty())
				{
					set_output(reinterpret_cast<std::uint8_t *>(buffer) + actual, length - actual);
					bool stream_end;
					err = decompress_some(stream_end);
					actual += output_produced();

					if (stream_end)
					{
						assert(!err);
						if constexpr (std::is_base_of_v<random_read, Stream>)
						{
							if (!input_empty())
							{
								std::int64_t const overshoot = std::uint64_t(input_available());
								reset_input();
								return this->object().seek(-overshoot, SEEK_CUR);
							}
						}
						else
						{
							return std::error_condition();
						}
					}
				}
			}
			while (!err && (length > actual) && !short_input);
		}

		return err;
	}
};


// filter for deflating data

class zlib_write_filter : public write_stream, protected filter_base<write_stream>, protected deflate_data
{
public:
	zlib_write_filter(write_stream::ptr &&stream, int level, std::size_t buffer_size) noexcept :
		filter_base<write_stream>(std::move(stream)),
		deflate_data(level, buffer_size)
	{
	}

	zlib_write_filter(write_stream &stream, int level, std::size_t buffer_size) noexcept :
		filter_base<write_stream>(stream),
		deflate_data(level, buffer_size)
	{
	}

	~zlib_write_filter()
	{
		finalize();
	}

	virtual std::error_condition finalize() noexcept override
	{
		if (!stream_initialized())
			return std::error_condition();

		do
		{
			if (!compression_finished() && output_available())
			{
				std::error_condition err = finish_compression();
				if (err)
					return err;
			}

			while ((compression_finished() && get_output().second) || !output_available())
			{
				std::error_condition err = write_some();
				if (err)
					return err;
			}
		}
		while (!compression_finished());

		return close_z_stream();
	}

	virtual std::error_condition flush() noexcept override
	{
		if (stream_initialized())
		{
			auto const output = get_output();
			if (output.second)
			{
				std::size_t written;
				std::error_condition err = object().write(output.first, output.second, written);
				consume_output(written);
				if (err)
				{
					object().flush();
					return err;
				}
			}
		}
		return object().flush();
	}

	virtual std::error_condition write(void const *buffer, std::size_t length, std::size_t &actual) noexcept override
	{
		std::error_condition err;
		actual = 0U;

		if (!stream_initialized())
		{
			err = initialize_z_stream();
		}
		else if (compression_finished())
		{
			while (!err && get_output().second)
				err = write_some();
			if (!err)
				err = reset_z_stream();
		}

		while (!err && (length > actual))
		{
			set_input(reinterpret_cast<std::uint8_t const *>(buffer) + actual, length - actual);
			do
			{
				if (output_available())
					err = compress_some();

				while (!err && !output_available())
					err = write_some();
			}
			while (!err && !input_empty());
			actual += input_used();
		}

		return err;
	}

private:
	std::error_condition write_some() noexcept
	{
		auto const output = get_output();
		std::size_t written;
		std::error_condition err = object().write(output.first, output.second, written);
		consume_output(written);
		return err;
	}
};

} // anonymous namespace


// creating decompressing filters

read_stream::ptr zlib_read(read_stream::ptr &&stream, std::size_t read_chunk) noexcept
{
	read_stream::ptr result;
	if (stream)
		result.reset(new (std::nothrow) zlib_read_filter<read_stream>(std::move(stream), read_chunk));
	return result;
}

read_stream::ptr zlib_read(random_read::ptr &&stream, std::size_t read_chunk) noexcept
{
	read_stream::ptr result;
	if (stream)
		result.reset(new (std::nothrow) zlib_read_filter<random_read>(std::move(stream), read_chunk));
	return result;
}

read_stream::ptr zlib_read(read_stream &stream, std::size_t read_chunk) noexcept
{
	return read_stream::ptr(new (std::nothrow) zlib_read_filter<read_stream>(stream, read_chunk));
}

read_stream::ptr zlib_read(random_read &stream, std::size_t read_chunk) noexcept
{
	return read_stream::ptr(new (std::nothrow) zlib_read_filter<random_read>(stream, read_chunk));
}


// creating compressing filters

write_stream::ptr zlib_write(write_stream::ptr &&stream, int level, std::size_t buffer_size) noexcept
{
	write_stream::ptr result;
	if (stream)
		result.reset(new (std::nothrow) zlib_write_filter(std::move(stream), level, buffer_size));
	return result;
}

write_stream::ptr zlib_write(write_stream &stream, int level, std::size_t buffer_size) noexcept
{
	return write_stream::ptr(new (std::nothrow) zlib_write_filter(stream, level, buffer_size));
}

} // namespace util