std/xz: add delta filter

This commit is contained in:
Nigel Tao committed 2024-01-07 09:14:11 +11:00
1 parent 1e5cf45090
commit d4ececf1d4
3 files changed
+229 -30

No files matched your search

+127 -13
View File
@@ -13789,12 +13789,12 @@ struct wuffs_xxhash64__hasher__struct {
extern const char wuffs_xz__error__bad_block_header[];
extern const char wuffs_xz__error__bad_checksum[];
extern const char wuffs_xz__error__bad_filter[];
extern const char wuffs_xz__error__bad_header[];
extern const char wuffs_xz__error__bad_padding[];
extern const char wuffs_xz__error__truncated_input[];
extern const char wuffs_xz__error__unsupported_checksum_algorithm[];
extern const char wuffs_xz__error__unsupported_filter[];
extern const char wuffs_xz__error__unsupported_number_of_filters[];
// ---------------- Public Consts
@@ -13913,6 +13913,8 @@ struct wuffs_xz__decoder__struct {
wuffs_base__vtable null_vtable;
uint32_t f_placeholder;
uint32_t f_filters[3];
uint32_t f_num_non_final_filters;
uint32_t f_checksummer;
bool f_ignore_checksum;
bool f_block_has_compressed_size;
@@ -13927,6 +13929,7 @@ struct wuffs_xz__decoder__struct {
} private_impl;
struct {
uint8_t f_filter_data[3][256];
wuffs_crc32__ieee_hasher f_crc32;
wuffs_crc64__ecma_hasher f_crc64;
wuffs_sha256__hasher f_sha256;
@@ -13946,6 +13949,7 @@ struct wuffs_xz__decoder__struct {
struct {
uint8_t v_flags;
uint32_t v_shift;
uint32_t v_f;
} s_decode_block_header_sans_padding;
} private_data;
@@ -66557,12 +66561,12 @@ wuffs_xxhash64__hasher__checksum_u64(
const char wuffs_xz__error__bad_block_header[] = "#xz: bad block header";
const char wuffs_xz__error__bad_checksum[] = "#xz: bad checksum";
const char wuffs_xz__error__bad_filter[] = "#xz: bad filter";
const char wuffs_xz__error__bad_header[] = "#xz: bad header";
const char wuffs_xz__error__bad_padding[] = "#xz: bad padding";
const char wuffs_xz__error__truncated_input[] = "#xz: truncated input";
const char wuffs_xz__error__unsupported_checksum_algorithm[] = "#xz: unsupported checksum algorithm";
const char wuffs_xz__error__unsupported_filter[] = "#xz: unsupported filter";
const char wuffs_xz__error__unsupported_number_of_filters[] = "#xz: unsupported number of filters";
// ---------------- Private Consts
@@ -66590,6 +66594,12 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
wuffs_xz__decoder* self,
wuffs_base__io_buffer* a_src);
WUFFS_BASE__GENERATED_C_CODE
static wuffs_base__empty_struct
wuffs_xz__decoder__apply_non_final_filters(
wuffs_xz__decoder* self,
wuffs_base__slice_u8 a_dst_slice);
// ---------------- VTables
const wuffs_base__io_transformer__func_ptrs
@@ -67094,6 +67104,9 @@ wuffs_xz__decoder__do_transform_io(
}
v_compressed_size += wuffs_private_impl__io__count_since(v_smark, ((uint64_t)(iop_a_src - io0_a_src)));
v_uncompressed_size += wuffs_private_impl__io__count_since(v_dmark, ((uint64_t)(iop_a_dst - io0_a_dst)));
if (self->private_impl.f_num_non_final_filters != 0u) {
wuffs_xz__decoder__apply_non_final_filters(self, wuffs_private_impl__io__since(v_dmark, ((uint64_t)(iop_a_dst - io0_a_dst)), io0_a_dst));
}
if (self->private_impl.f_ignore_checksum) {
} else if (self->private_impl.f_checksummer == 1u) {
wuffs_crc32__ieee_hasher__update(&self->private_data.f_crc32, wuffs_private_impl__io__since(v_dmark, ((uint64_t)(iop_a_dst - io0_a_dst)), io0_a_dst));
@@ -67479,6 +67492,8 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
uint8_t v_filter_id = 0;
wuffs_base__status v_status = wuffs_base__make_status(NULL);
uint32_t v_shift = 0;
uint32_t v_f = 0;
uint32_t v_k = 0;
const uint8_t* iop_a_src = NULL;
const uint8_t* io0_a_src WUFFS_BASE__POTENTIALLY_UNUSED = NULL;
@@ -67495,6 +67510,7 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
if (coro_susp_point) {
v_flags = self->private_data.s_decode_block_header_sans_padding.v_flags;
v_shift = self->private_data.s_decode_block_header_sans_padding.v_shift;
v_f = self->private_data.s_decode_block_header_sans_padding.v_f;
}
switch (coro_susp_point) {
WUFFS_BASE__COROUTINE_SUSPENSION_POINT_0;
@@ -67508,10 +67524,7 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
uint8_t t_0 = *iop_a_src++;
v_flags = t_0;
}
if (((uint8_t)(v_flags & 3u)) != 0u) {
status = wuffs_base__make_status(wuffs_xz__error__unsupported_number_of_filters);
goto exit;
}
self->private_impl.f_num_non_final_filters = ((uint32_t)(((uint8_t)(v_flags & 3u))));
if (((uint8_t)(v_flags & 60u)) != 0u) {
status = wuffs_base__make_status(wuffs_xz__error__bad_block_header);
goto exit;
@@ -67574,7 +67587,8 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
break;
}
}
while (true) {
v_f = 0u;
while (v_f < self->private_impl.f_num_non_final_filters) {
{
WUFFS_BASE__COROUTINE_SUSPENSION_POINT(4);
if (WUFFS_BASE__UNLIKELY(iop_a_src == io2_a_src)) {
@@ -67585,6 +67599,9 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
v_filter_id = t_3;
}
if (v_filter_id == 33u) {
status = wuffs_base__make_status(wuffs_xz__error__bad_filter);
goto exit;
} else if (v_filter_id == 3u) {
{
WUFFS_BASE__COROUTINE_SUSPENSION_POINT(5);
if (WUFFS_BASE__UNLIKELY(iop_a_src == io2_a_src)) {
@@ -67595,7 +67612,7 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
v_c8 = t_4;
}
if (v_c8 != 1u) {
status = wuffs_base__make_status(wuffs_xz__error__bad_block_header);
status = wuffs_base__make_status(wuffs_xz__error__bad_filter);
goto exit;
}
{
@@ -67607,13 +67624,59 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
uint8_t t_5 = *iop_a_src++;
v_c8 = t_5;
}
v_status = wuffs_lzma__decoder__set_quirk(&self->private_data.f_lzma, 1348001792u, (2u | (((uint64_t)(v_c8)) << 8u)));
if ( ! wuffs_base__status__is_ok(&v_status)) {
status = wuffs_base__make_status(wuffs_xz__error__bad_block_header);
goto exit;
self->private_impl.f_filters[v_f] = ((((uint32_t)(v_c8)) << 8u) | 3u);
v_k = 0u;
while (v_k < 256u) {
self->private_data.f_filter_data[v_f][v_k] = 0u;
v_k += 1u;
}
break;
} else {
status = wuffs_base__make_status(wuffs_xz__error__unsupported_filter);
goto exit;
}
v_f += 1u;
}
{
WUFFS_BASE__COROUTINE_SUSPENSION_POINT(7);
if (WUFFS_BASE__UNLIKELY(iop_a_src == io2_a_src)) {
status = wuffs_base__make_status(wuffs_base__suspension__short_read);
goto suspend;
}
uint8_t t_6 = *iop_a_src++;
v_filter_id = t_6;
}
if (v_filter_id == 33u) {
{
WUFFS_BASE__COROUTINE_SUSPENSION_POINT(8);
if (WUFFS_BASE__UNLIKELY(iop_a_src == io2_a_src)) {
status = wuffs_base__make_status(wuffs_base__suspension__short_read);
goto suspend;
}
uint8_t t_7 = *iop_a_src++;
v_c8 = t_7;
}
if (v_c8 != 1u) {
status = wuffs_base__make_status(wuffs_xz__error__bad_filter);
goto exit;
}
{
WUFFS_BASE__COROUTINE_SUSPENSION_POINT(9);
if (WUFFS_BASE__UNLIKELY(iop_a_src == io2_a_src)) {
status = wuffs_base__make_status(wuffs_base__suspension__short_read);
goto suspend;
}
uint8_t t_8 = *iop_a_src++;
v_c8 = t_8;
}
v_status = wuffs_lzma__decoder__set_quirk(&self->private_data.f_lzma, 1348001792u, (2u | (((uint64_t)(v_c8)) << 8u)));
if ( ! wuffs_base__status__is_ok(&v_status)) {
status = wuffs_base__make_status(wuffs_xz__error__bad_filter);
goto exit;
}
} else if (v_filter_id == 3u) {
status = wuffs_base__make_status(wuffs_xz__error__bad_filter);
goto exit;
} else {
status = wuffs_base__make_status(wuffs_xz__error__unsupported_filter);
goto exit;
}
@@ -67629,6 +67692,7 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
self->private_impl.p_decode_block_header_sans_padding = wuffs_base__status__is_suspension(&status) ? coro_susp_point : 0;
self->private_data.s_decode_block_header_sans_padding.v_flags = v_flags;
self->private_data.s_decode_block_header_sans_padding.v_shift = v_shift;
self->private_data.s_decode_block_header_sans_padding.v_f = v_f;
goto exit;
exit:
@@ -67639,6 +67703,56 @@ wuffs_xz__decoder__decode_block_header_sans_padding(
return status;
}
// -------- func xz.decoder.apply_non_final_filters
WUFFS_BASE__GENERATED_C_CODE
static wuffs_base__empty_struct
wuffs_xz__decoder__apply_non_final_filters(
wuffs_xz__decoder* self,
wuffs_base__slice_u8 a_dst_slice) {
uint32_t v_f = 0;
uint64_t v_i = 0;
uint32_t v_filter_id = 0;
uint32_t v_delta_dist = 0;
uint32_t v_delta_pos = 0;
uint8_t v_c8 = 0;
if (self->private_impl.f_num_non_final_filters <= 0u) {
return wuffs_base__make_empty_struct();
}
v_f = (self->private_impl.f_num_non_final_filters - 1u);
while (true) {
v_filter_id = (self->private_impl.f_filters[v_f] & 127u);
if (v_filter_id == 3u) {
v_delta_dist = (((self->private_impl.f_filters[v_f] >> 8u) & 255u) + 1u);
v_delta_pos = (self->private_impl.f_filters[v_f] >> 24u);
v_i = 0u;
while (v_i < ((uint64_t)(a_dst_slice.len))) {
v_c8 = a_dst_slice.ptr[v_i];
#if defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wconversion"
#endif
v_c8 += self->private_data.f_filter_data[v_f][(((uint32_t)(v_delta_dist + v_delta_pos)) & 255u)];
#if defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
self->private_data.f_filter_data[v_f][(v_delta_pos & 255u)] = v_c8;
v_delta_pos -= 1u;
a_dst_slice.ptr[v_i] = v_c8;
v_i += 1u;
}
self->private_impl.f_filters[v_f] &= 65535u;
self->private_impl.f_filters[v_f] |= ((uint32_t)(v_delta_pos << 24u));
}
if (v_f <= 0u) {
break;
}
v_f -= 1u;
}
return wuffs_base__make_empty_struct();
}
#endif // !defined(WUFFS_CONFIG__MODULES) || defined(WUFFS_CONFIG__MODULE__XZ)
#if defined(__cplusplus) && defined(WUFFS_BASE__HAVE_UNIQUE_PTR)
+100 -17
View File
@@ -19,12 +19,12 @@ use "std/sha256"
pub status "#bad block header"
pub status "#bad checksum"
pub status "#bad filter"
pub status "#bad header"
pub status "#bad padding"
pub status "#truncated input"
pub status "#unsupported checksum algorithm"
pub status "#unsupported filter"
pub status "#unsupported number of filters"
pub const DECODER_DST_HISTORY_RETAIN_LENGTH_MAX_INCL_WORST_CASE : base.u64 = 0xFFFF_FFFF
@@ -33,6 +33,9 @@ pub const DECODER_WORKBUF_LEN_MAX_INCL_WORST_CASE : base.u64 = 0
pub struct decoder? implements base.io_transformer(
placeholder : base.u32,
filters : array[3] base.u32,
num_non_final_filters : base.u32[..= 3],
// 0: None.
// 1: CRC-32.
// 2: CRC-64.
@@ -49,6 +52,8 @@ pub struct decoder? implements base.io_transformer(
util : base.utility,
) + (
filter_data : array[3] array[256] base.u8,
crc32 : crc32.ieee_hasher,
crc64 : crc64.ecma_hasher,
sha256 : sha256.hasher,
@@ -178,7 +183,9 @@ pri func decoder.do_transform_io?(dst: base.io_writer, src: base.io_reader, work
compressed_size ~mod+= args.src.count_since(mark: smark)
uncompressed_size ~mod+= args.dst.count_since(mark: dmark)
// TODO: apply any filters that aren't LZMA2.
if this.num_non_final_filters <> 0 {
this.apply_non_final_filters!(dst_slice: args.dst.since(mark: dmark))
}
if this.ignore_checksum {
// No-op.
@@ -285,12 +292,11 @@ pri func decoder.decode_block_header_sans_padding?(src: base.io_reader) {
var filter_id : base.u8
var status : base.status
var shift : base.u32
var f : base.u32
var k : base.u32
flags = args.src.read_u8?()
if (flags & 0x03) <> 0 {
return "#unsupported number of filters"
}
this.num_non_final_filters = (flags & 0x03) as base.u32
if (flags & 0x3C) <> 0 {
return "#bad block header"
}
@@ -339,24 +345,101 @@ pri func decoder.decode_block_header_sans_padding?(src: base.io_reader) {
} endwhile
}
while true {
// Configure the non-final filters.
f = 0
while f < this.num_non_final_filters {
assert f < 3 via "a < b: a < c; c <= b"(c: this.num_non_final_filters)
filter_id = args.src.read_u8?()
if filter_id == 0x21 { // LZMA2
// LZMA2's "Size of Properties" should be 1.
return "#bad filter"
} else if filter_id == 0x03 { // Delta.
// Delta's "Size of Properties" should be 1.
c8 = args.src.read_u8?()
if c8 <> 0x01 {
return "#bad block header"
return "#bad filter"
}
// Pass that 1 Properties byte on to the LZMA decoder.
// Stash that 1 Properties byte on to the LZMA decoder.
c8 = args.src.read_u8?()
status = this.lzma.set_quirk!(
key: lzma.QUIRK_FORMAT_EXTENSION,
value: 0x02 | ((c8 as base.u64) << 8))
if not status.is_ok() {
return "#bad block header"
}
this.filters[f] = ((c8 as base.u32) << 8) | 0x03
k = 0
while k < 0x100,
inv f < 3,
{
this.filter_data[f][k] = 0x00
k += 1
} endwhile
} else {
return "#unsupported filter"
}
f += 1
} endwhile
// Configure the final filter (which must be LZMA2).
filter_id = args.src.read_u8?()
if filter_id == 0x21 { // LZMA2
// LZMA2's "Size of Properties" should be 1.
c8 = args.src.read_u8?()
if c8 <> 0x01 {
return "#bad filter"
}
// Pass that 1 Properties byte on to the LZMA decoder.
c8 = args.src.read_u8?()
status = this.lzma.set_quirk!(
key: lzma.QUIRK_FORMAT_EXTENSION,
value: 0x02 | ((c8 as base.u64) << 8))
if not status.is_ok() {
return "#bad filter"
}
} else if filter_id == 0x03 { // Delta.
return "#bad filter"
} else {
return "#unsupported filter"
}
}
pri func decoder.apply_non_final_filters!(dst_slice: slice base.u8) {
var f : base.u32[..= 2]
var i : base.u64
var filter_id : base.u32[..= 0x7F]
var delta_dist : base.u32[..= 0x100]
var delta_pos : base.u32
var c8 : base.u8
if this.num_non_final_filters <= 0 {
return nothing
}
f = this.num_non_final_filters - 1
while true {
filter_id = this.filters[f] & 0x7F
if filter_id == 0x03 { // Delta.
delta_dist = ((this.filters[f] >> 8) & 0xFF) + 1
delta_pos = this.filters[f] >> 24
i = 0
while i < args.dst_slice.length() {
assert i < 0xFFFF_FFFF_FFFF_FFFF via "a < b: a < c; c <= b"(c: args.dst_slice.length())
c8 = args.dst_slice[i]
c8 ~mod+= this.filter_data[f][(delta_dist ~mod+ delta_pos) & 0xFF]
this.filter_data[f][delta_pos & 0xFF] = c8
delta_pos ~mod-= 1
args.dst_slice[i] = c8
i += 1
} endwhile
this.filters[f] &= 0xFFFF
this.filters[f] |= (delta_pos ~mod<< 24)
}
if f <= 0 {
break
}
return "#unsupported filter"
f -= 1
} endwhile
}
@@ -45,6 +45,7 @@ OK. 00000000 test/3pdata/xzsuite/good-0-empty.xz
OK. 00000000 test/3pdata/xzsuite/good-0cat-empty.xz
OK. 00000000 test/3pdata/xzsuite/good-0catpad-empty.xz
OK. 00000000 test/3pdata/xzsuite/good-0pad-empty.xz
OK. db4847fb test/3pdata/xzsuite/good-1-3delta-lzma2.xz
OK. 15a2a343 test/3pdata/xzsuite/good-1-block_header-1.xz
OK. 15a2a343 test/3pdata/xzsuite/good-1-block_header-2.xz
OK. 15a2a343 test/3pdata/xzsuite/good-1-block_header-3.xz
@@ -52,6 +53,7 @@ OK. 15a2a343 test/3pdata/xzsuite/good-1-check-crc32.xz
OK. 15a2a343 test/3pdata/xzsuite/good-1-check-crc64.xz
OK. 15a2a343 test/3pdata/xzsuite/good-1-check-none.xz
OK. 15a2a343 test/3pdata/xzsuite/good-1-check-sha256.xz
OK. f7c66eb5 test/3pdata/xzsuite/good-1-delta-lzma2.tiff.xz
OK. db4847fb test/3pdata/xzsuite/good-1-lzma2-1.xz
OK. db4847fb test/3pdata/xzsuite/good-1-lzma2-2.xz
OK. db4847fb test/3pdata/xzsuite/good-1-lzma2-3.xz