Files
wuffs/test/c/std/lzw.c
T
Nigel Tao 010df42d75 Have std/lzw always rewind excess bits
I'm not sure of the underlying reason for the lzw/gcc benchmark anomaly
(the gif/gcc numbers don't change), but it's the same mystery as commit
ecb3995 `Tweak how std/lzw yields "short read"`.

name                                    old speed      new speed      delta

wuffs_lzw_decode_20k/clang               223MB/s ± 0%   214MB/s ± 0%   -3.96%  (p=0.008 n=5+5)
wuffs_lzw_decode_100k/clang              385MB/s ± 0%   369MB/s ± 0%   -4.15%  (p=0.008 n=5+5)

wuffs_lzw_decode_20k/gcc                 186MB/s ± 1%   232MB/s ± 1%  +24.41%  (p=0.008 n=5+5)
wuffs_lzw_decode_100k/gcc                224MB/s ± 1%   384MB/s ± 1%  +71.81%  (p=0.008 n=5+5)

wuffs_gif_decode_1k_bw/clang             238MB/s ± 1%   236MB/s ± 0%     ~     (p=0.222 n=5+5)
wuffs_gif_decode_1k_color/clang          124MB/s ± 0%   118MB/s ± 1%   -4.75%  (p=0.008 n=5+5)
wuffs_gif_decode_10k_bgra/clang          596MB/s ± 0%   562MB/s ± 0%   -5.71%  (p=0.008 n=5+5)
wuffs_gif_decode_10k_indexed/clang       159MB/s ± 0%   149MB/s ± 0%   -6.42%  (p=0.008 n=5+5)
wuffs_gif_decode_100k_artificial/clang   492MB/s ± 1%   487MB/s ± 0%   -0.98%  (p=0.008 n=5+5)
wuffs_gif_decode_100k_realistic/clang    192MB/s ± 0%   183MB/s ± 0%   -5.07%  (p=0.008 n=5+5)
wuffs_gif_decode_1000k/clang             195MB/s ± 0%   185MB/s ± 0%   -4.93%  (p=0.008 n=5+5)
wuffs_gif_decode_anim_screencap/clang   1.01GB/s ± 1%  1.02GB/s ± 0%   +1.25%  (p=0.008 n=5+5)

wuffs_gif_decode_1k_bw/gcc               247MB/s ± 0%   250MB/s ± 0%   +1.26%  (p=0.008 n=5+5)
wuffs_gif_decode_1k_color/gcc            131MB/s ± 2%   133MB/s ± 0%     ~     (p=0.151 n=5+5)
wuffs_gif_decode_10k_bgra/gcc            541MB/s ± 1%   543MB/s ± 1%     ~     (p=0.548 n=5+5)
wuffs_gif_decode_10k_indexed/gcc         167MB/s ± 0%   167MB/s ± 1%     ~     (p=0.730 n=4+5)
wuffs_gif_decode_100k_artificial/gcc     469MB/s ± 0%   465MB/s ± 1%   -0.78%  (p=0.016 n=4+5)
wuffs_gif_decode_100k_realistic/gcc      190MB/s ± 0%   190MB/s ± 0%   -0.34%  (p=0.032 n=4+5)
wuffs_gif_decode_1000k/gcc               193MB/s ± 1%   192MB/s ± 1%     ~     (p=0.556 n=4+5)
wuffs_gif_decode_anim_screencap/gcc      995MB/s ± 1%   995MB/s ± 1%     ~     (p=0.841 n=5+5)
2018-12-22 14:05:34 +11:00

330 lines
11 KiB
C

// Copyright 2017 The Wuffs Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/*
This test program is typically run indirectly, by the "wuffs test" or "wuffs
bench" commands. These commands take an optional "-mimic" flag to check that
Wuffs' output mimics (i.e. exactly matches) other libraries' output, such as
giflib for GIF, libpng for PNG, etc.
To manually run this test:
for CC in clang gcc; do
$CC -std=c99 -Wall -Werror lzw.c && ./a.out
rm -f a.out
done
Each edition should print "PASS", amongst other information, and exit(0).
Add the "wuffs mimic cflags" (everything after the colon below) to the C
compiler flags (after the .c file) to run the mimic tests.
To manually run the benchmarks, replace "-Wall -Werror" with "-O3" and replace
the first "./a.out" with "./a.out -bench". Combine these changes with the
"wuffs mimic cflags" to run the mimic benchmarks.
*/
// !! wuffs mimic cflags: -DWUFFS_MIMIC
// Wuffs ships as a "single file C library" or "header file library" as per
// https://github.com/nothings/stb/blob/master/docs/stb_howto.txt
//
// To use that single file as a "foo.c"-like implementation, instead of a
// "foo.h"-like header, #define WUFFS_IMPLEMENTATION before #include'ing or
// compiling it.
#define WUFFS_IMPLEMENTATION
// Defining the WUFFS_CONFIG__MODULE* macros are optional, but it lets users of
// release/c/etc.h whitelist which parts of Wuffs to build. That file contains
// the entire Wuffs standard library, implementing a variety of codecs and file
// formats. Without this macro definition, an optimizing compiler or linker may
// very well discard Wuffs code for unused codecs, but listing the Wuffs
// modules we use makes that process explicit. Preprocessing means that such
// code simply isn't compiled.
#define WUFFS_CONFIG__MODULES
#define WUFFS_CONFIG__MODULE__BASE
#define WUFFS_CONFIG__MODULE__LZW
// If building this program in an environment that doesn't easily accommodate
// relative includes, you can use the script/inline-c-relative-includes.go
// program to generate a stand-alone C file.
#include "../../../release/c/wuffs-unsupported-snapshot.h"
#include "../testlib/testlib.c"
// ---------------- LZW Tests
const char* do_test_wuffs_lzw_decode(const char* src_filename,
uint64_t src_size,
const char* want_filename,
uint64_t want_size,
uint64_t wlimit,
uint64_t rlimit) {
wuffs_base__io_buffer got = ((wuffs_base__io_buffer){
.data = global_got_slice,
});
wuffs_base__io_buffer want = ((wuffs_base__io_buffer){
.data = global_want_slice,
});
wuffs_base__io_buffer src = ((wuffs_base__io_buffer){
.data = global_src_slice,
});
const char* z = read_file(&src, src_filename);
if (z) {
return z;
}
if (src.meta.wi != src_size) {
RETURN_FAIL("src size: got %d, want %d", (int)(src.meta.wi),
(int)(src_size));
}
// The first byte in that file, the LZW literal width, should be 0x08.
uint8_t literal_width = src.data.ptr[0];
if (literal_width != 0x08) {
RETURN_FAIL("LZW literal width: got %d, want %d", (int)(src.data.ptr[0]),
0x08);
}
src.meta.ri++;
z = read_file(&want, want_filename);
if (z) {
return z;
}
if (want.meta.wi != want_size) {
RETURN_FAIL("want size: got %d, want %d", (int)(want.meta.wi),
(int)(want_size));
}
wuffs_lzw__decoder dec = ((wuffs_lzw__decoder){});
z = wuffs_lzw__decoder__check_wuffs_version(&dec, sizeof dec, WUFFS_VERSION);
if (z) {
RETURN_FAIL("check_wuffs_version: \"%s\"", z);
}
wuffs_lzw__decoder__set_literal_width(&dec, literal_width);
int num_iters = 0;
while (true) {
num_iters++;
wuffs_base__io_writer got_writer = wuffs_base__io_buffer__writer(&got);
if (wlimit) {
set_writer_limit(&got_writer, wlimit);
}
wuffs_base__io_reader src_reader = wuffs_base__io_buffer__reader(&src);
if (rlimit) {
set_reader_limit(&src_reader, rlimit);
}
size_t old_wi = got.meta.wi;
size_t old_ri = src.meta.ri;
z = wuffs_lzw__decoder__decode(&dec, got_writer, src_reader);
if (!z) {
if (src.meta.ri != src.meta.wi) {
RETURN_FAIL("decode returned \"ok\" but src was not exhausted");
}
break;
}
if ((z != wuffs_base__suspension__short_read) &&
(z != wuffs_base__suspension__short_write)) {
RETURN_FAIL("decode: got \"%s\", want \"%s\" or \"%s\"", z,
wuffs_base__suspension__short_read,
wuffs_base__suspension__short_write);
}
if (got.meta.wi < old_wi) {
RETURN_FAIL("write index got.wi went backwards");
}
if (src.meta.ri < old_ri) {
RETURN_FAIL("read index src.ri went backwards");
}
if ((got.meta.wi == old_wi) && (src.meta.ri == old_ri)) {
RETURN_FAIL("no progress was made");
}
}
if (wlimit || rlimit) {
if (num_iters <= 1) {
RETURN_FAIL("num_iters: got %d, want > 1", num_iters);
}
} else {
if (num_iters != 1) {
RETURN_FAIL("num_iters: got %d, want 1", num_iters);
}
}
return check_io_buffers_equal("", &got, &want);
}
const char* test_wuffs_lzw_decode_bricks_dither() {
CHECK_FOCUS(__func__);
return do_test_wuffs_lzw_decode("test/data/bricks-dither.indexes.giflzw",
14923, "test/data/bricks-dither.indexes",
19200, 0, 0);
}
const char* test_wuffs_lzw_decode_bricks_nodither() {
CHECK_FOCUS(__func__);
return do_test_wuffs_lzw_decode("test/data/bricks-nodither.indexes.giflzw",
13382, "test/data/bricks-nodither.indexes",
19200, 0, 0);
}
const char* test_wuffs_lzw_decode_many_big_reads() {
CHECK_FOCUS(__func__);
return do_test_wuffs_lzw_decode("test/data/bricks-gray.indexes.giflzw", 14731,
"test/data/bricks-gray.indexes", 19200, 0,
4096);
}
const char* test_wuffs_lzw_decode_many_small_writes_reads() {
CHECK_FOCUS(__func__);
return do_test_wuffs_lzw_decode("test/data/bricks-gray.indexes.giflzw", 14731,
"test/data/bricks-gray.indexes", 19200, 41,
43);
}
const char* test_wuffs_lzw_decode_pi() {
CHECK_FOCUS(__func__);
return do_test_wuffs_lzw_decode("test/data/pi.txt.giflzw", 50550,
"test/data/pi.txt", 100003, 0, 0);
}
const char* test_wuffs_lzw_decode_output_empty() {
CHECK_FOCUS(__func__);
wuffs_base__io_buffer got = ((wuffs_base__io_buffer){
.data = global_got_slice,
});
wuffs_base__io_buffer src = ((wuffs_base__io_buffer){
.data = global_src_slice,
});
// Set up src to be 20 bytes long, starting with the 9-bit end code 0x101.
// Decoding should consume only 2 of those bytes.
src.meta.wi = 20;
int i;
for (i = 0; i < src.meta.wi; i++) {
src.data.ptr[i] = 0;
}
src.data.ptr[0] = 0x01;
src.data.ptr[1] = 0x01;
wuffs_lzw__decoder dec = ((wuffs_lzw__decoder){});
const char* z =
wuffs_lzw__decoder__check_wuffs_version(&dec, sizeof dec, WUFFS_VERSION);
if (z) {
RETURN_FAIL("check_wuffs_version: \"%s\"", z);
}
wuffs_lzw__decoder__set_literal_width(&dec, 8);
z = wuffs_lzw__decoder__decode(&dec, wuffs_base__io_buffer__writer(&got),
wuffs_base__io_buffer__reader(&src));
if (z) {
RETURN_FAIL("decode: \"%s\"", z);
}
if (got.meta.wi != 0) {
RETURN_FAIL("got.meta.wi: got %d, want 0", (int)(got.meta.wi));
}
if (src.meta.ri != 2) {
RETURN_FAIL("src.meta.ri: got %d, want 2", (int)(src.meta.ri));
}
return NULL;
}
// ---------------- LZW Benches
const char* do_bench_wuffs_lzw_decode(const char* filename,
uint64_t iters_unscaled) {
wuffs_base__io_buffer got = ((wuffs_base__io_buffer){
.data = global_got_slice,
});
wuffs_base__io_buffer src = ((wuffs_base__io_buffer){
.data = global_src_slice,
});
wuffs_base__io_writer got_writer = wuffs_base__io_buffer__writer(&got);
wuffs_base__io_reader src_reader = wuffs_base__io_buffer__reader(&src);
const char* z = read_file(&src, filename);
if (z) {
return z;
}
if (src.meta.wi <= 0) {
RETURN_FAIL("src size: got %d, want > 0", (int)(src.meta.wi));
}
uint8_t literal_width = src.data.ptr[0];
if (literal_width != 0x08) {
RETURN_FAIL("LZW literal width: got %d, want %d", (int)(src.data.ptr[0]),
0x08);
}
bench_start();
uint64_t n_bytes = 0;
uint64_t i;
uint64_t iters = iters_unscaled * iterscale;
for (i = 0; i < iters; i++) {
got.meta.wi = 0;
src.meta.ri = 1; // Skip the literal width.
wuffs_lzw__decoder dec = ((wuffs_lzw__decoder){});
z = wuffs_lzw__decoder__check_wuffs_version(&dec, sizeof dec,
WUFFS_VERSION);
if (z) {
RETURN_FAIL("check_wuffs_version: \"%s\"", z);
}
z = wuffs_lzw__decoder__decode(&dec, got_writer, src_reader);
if (z) {
RETURN_FAIL("decode: \"%s\"", z);
}
n_bytes += got.meta.wi;
}
bench_finish(iters, n_bytes);
return NULL;
}
const char* bench_wuffs_lzw_decode_20k() {
CHECK_FOCUS(__func__);
return do_bench_wuffs_lzw_decode("test/data/bricks-gray.indexes.giflzw", 50);
}
const char* bench_wuffs_lzw_decode_100k() {
CHECK_FOCUS(__func__);
return do_bench_wuffs_lzw_decode("test/data/pi.txt.giflzw", 10);
}
// ---------------- Manifest
// The empty comments forces clang-format to place one element per line.
proc tests[] = {
test_wuffs_lzw_decode_bricks_dither, //
test_wuffs_lzw_decode_bricks_nodither, //
test_wuffs_lzw_decode_many_big_reads, //
test_wuffs_lzw_decode_many_small_writes_reads, //
test_wuffs_lzw_decode_output_empty, //
test_wuffs_lzw_decode_pi, //
NULL,
};
// The empty comments forces clang-format to place one element per line.
proc benches[] = {
bench_wuffs_lzw_decode_20k, //
bench_wuffs_lzw_decode_100k, //
NULL,
};
int main(int argc, char** argv) {
proc_package_name = "std/lzw";
return test_main(argc, argv, tests, benches);
}