mirror of
https://github.com/ddidderr/wuffs.git
synced 2026-11-22 00:47:28 +01:00
It's not immediately obvious why this data structure performs differently, but on net, the benchmark numbers seem better. It also won't require any PUFFS_USE_NO_OP_PERFORMANCE_HACKS or "redundant but mysteriously performant" use_limit fields. name old speed new speed delta puffs_adler32_10k/clang 2.46GB/s ± 0% 2.43GB/s ± 3% ~ (p=0.513 n=5+10) puffs_adler32_100k/clang 2.46GB/s ± 0% 2.44GB/s ± 2% ~ (p=0.241 n=5+10) puffs_flate_decode_1k/clang 122MB/s ± 1% 119MB/s ± 2% -1.86% (p=0.013 n=5+10) puffs_flate_decode_10k/clang 147MB/s ± 0% 142MB/s ± 2% -3.47% (p=0.001 n=5+10) puffs_flate_decode_100k/clang 161MB/s ± 0% 161MB/s ± 4% ~ (p=0.635 n=4+10) puffs_zlib_decode_10k/clang 139MB/s ± 0% 135MB/s ± 1% -2.69% (p=0.001 n=5+10) puffs_zlib_decode_100k/clang 151MB/s ± 0% 152MB/s ± 3% ~ (p=1.000 n=5+10) puffs_adler32_10k/gcc 3.21GB/s ± 1% 3.18GB/s ± 2% ~ (p=0.310 n=5+10) puffs_adler32_100k/gcc 3.22GB/s ± 0% 3.19GB/s ± 2% ~ (p=0.075 n=5+10) puffs_flate_decode_1k/gcc 121MB/s ± 4% 126MB/s ± 1% +4.54% (p=0.002 n=5+8) puffs_flate_decode_10k/gcc 144MB/s ± 1% 141MB/s ± 1% -2.52% (p=0.001 n=5+9) puffs_flate_decode_100k/gcc 154MB/s ± 1% 158MB/s ± 0% +2.39% (p=0.001 n=5+9) puffs_zlib_decode_10k/gcc 137MB/s ± 2% 135MB/s ± 1% ~ (p=0.055 n=5+10) puffs_zlib_decode_100k/gcc 146MB/s ± 2% 150MB/s ± 0% +2.87% (p=0.001 n=5+10) puffs_gif_lzw_decode_20k/clang 132MB/s ± 0% 125MB/s ± 0% -5.24% (p=0.001 n=5+10) puffs_gif_lzw_decode_100k/clang 176MB/s ± 0% 164MB/s ± 0% -6.82% (p=0.001 n=5+9) puffs_gif_decode_1k/clang 363MB/s ± 0% 339MB/s ± 1% -6.58% (p=0.002 n=4+10) puffs_gif_decode_10k/clang 138MB/s ± 0% 133MB/s ± 1% -3.77% (p=0.001 n=5+10) puffs_gif_decode_100k/clang 125MB/s ± 0% 119MB/s ± 0% -4.79% (p=0.001 n=5+10) puffs_gif_decode_1000k/clang 127MB/s ± 0% 121MB/s ± 0% -5.04% (p=0.001 n=5+10) puffs_gif_lzw_decode_20k/gcc 141MB/s ± 0% 140MB/s ± 2% ~ (p=1.000 n=5+10) puffs_gif_lzw_decode_100k/gcc 182MB/s ± 0% 180MB/s ± 2% -1.56% (p=0.001 n=5+10) puffs_gif_decode_1k/gcc 363MB/s ± 0% 409MB/s ± 3% +12.71% (p=0.001 n=5+10) puffs_gif_decode_10k/gcc 127MB/s ± 0% 161MB/s ± 3% +26.15% (p=0.001 n=5+10) puffs_gif_decode_100k/gcc 112MB/s ± 0% 136MB/s ± 2% +21.95% (p=0.001 n=5+10) puffs_gif_decode_1000k/gcc 114MB/s ± 0% 140MB/s ± 2% +22.78% (p=0.001 n=5+10)
130 lines
4.6 KiB
C
130 lines
4.6 KiB
C
// After editing this file, run "go generate" in this directory.
|
|
|
|
#ifndef PUFFS_BASE_HEADER_H
|
|
#define PUFFS_BASE_HEADER_H
|
|
|
|
// Copyright 2017 The Puffs 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.
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
|
|
// Puffs requires a word size of at least 32 bits because it assumes that
|
|
// converting a u32 to usize will never overflow. For example, the size of a
|
|
// decoded image is often represented, explicitly or implicitly in an image
|
|
// file, as a u32, and it is convenient to compare that to a buffer size.
|
|
//
|
|
// Similarly, the word size is at most 64 bits because it assumes that
|
|
// converting a usize to u64 will never overflow.
|
|
#if __WORDSIZE < 32
|
|
#error "Puffs requires a word size of at least 32 bits"
|
|
#elif __WORDSIZE > 64
|
|
#error "Puffs requires a word size of at most 64 bits"
|
|
#endif
|
|
|
|
// PUFFS_VERSION is the major.minor version number as a uint32. The major
|
|
// number is the high 16 bits. The minor number is the low 16 bits.
|
|
//
|
|
// The intention is to bump the version number at least on every API / ABI
|
|
// backwards incompatible change.
|
|
//
|
|
// For now, the API and ABI are simply unstable and can change at any time.
|
|
//
|
|
// TODO: don't hard code this in base-header.h.
|
|
#define PUFFS_VERSION (0x00001)
|
|
|
|
// PUFFS_USE_NO_OP_PERFORMANCE_HACKS enables code paths that look like
|
|
// redundant no-ops, but for reasons to be investigated, can have dramatic
|
|
// performance effects with gcc 4.8.4 (e.g. 1.2x on some benchmarks).
|
|
//
|
|
// TODO: investigate; delete these hacks (without regressing performance).
|
|
// The order matters here. Clang also defines "__GNUC__".
|
|
#if defined(__clang__)
|
|
#elif defined(__GNUC__)
|
|
#define PUFFS_USE_NO_OP_PERFORMANCE_HACKS 1
|
|
#endif
|
|
|
|
// puffs_base__slice_u8 is a 1-dimensional buffer (a pointer and length).
|
|
//
|
|
// A value with all fields NULL or zero is a valid, empty slice.
|
|
typedef struct {
|
|
uint8_t* ptr;
|
|
size_t len;
|
|
} puffs_base__slice_u8;
|
|
|
|
// puffs_base__buf1 is a 1-dimensional buffer (a pointer and length), plus
|
|
// additional indexes into that buffer, plus an opened / closed flag.
|
|
//
|
|
// A value with all fields NULL or zero is a valid, empty buffer.
|
|
typedef struct {
|
|
uint8_t* ptr; // Pointer.
|
|
size_t len; // Length.
|
|
size_t wi; // Write index. Invariant: wi <= len.
|
|
size_t ri; // Read index. Invariant: ri <= wi.
|
|
bool closed; // No further writes are expected.
|
|
} puffs_base__buf1;
|
|
|
|
// puffs_base__limit1 provides a limited view of a 1-dimensional byte stream:
|
|
// its first N bytes. That N can be greater than a buffer's current read or
|
|
// write capacity. N decreases naturally over time as bytes are read from or
|
|
// written to the stream.
|
|
//
|
|
// A value with all fields NULL or zero is a valid, unlimited view.
|
|
typedef struct puffs_base__limit1 {
|
|
uint64_t* ptr_to_len; // Pointer to N.
|
|
struct puffs_base__limit1* next; // Linked list of limits.
|
|
} puffs_base__limit1;
|
|
|
|
#ifdef PUFFS_USE_NO_OP_PERFORMANCE_HACKS
|
|
typedef struct {
|
|
void* always_null0;
|
|
void* always_null1;
|
|
} puffs_base__paired_nulls;
|
|
#endif
|
|
|
|
typedef struct {
|
|
// TODO: move buf into private_impl? As it is, it looks like users can modify
|
|
// the buf field to point to a different buffer, which can turn the limit and
|
|
// mark fields into dangling pointers.
|
|
puffs_base__buf1* buf;
|
|
// Do not access the private_impl's fields directly. There is no API/ABI
|
|
// compatibility or safety guarantee if you do so.
|
|
struct {
|
|
puffs_base__limit1 limit;
|
|
uint8_t* mark;
|
|
#ifdef PUFFS_USE_NO_OP_PERFORMANCE_HACKS
|
|
struct {
|
|
puffs_base__paired_nulls* noph0;
|
|
uint32_t noph1;
|
|
} * no_op_performance_hacks;
|
|
#endif
|
|
} private_impl;
|
|
} puffs_base__reader1;
|
|
|
|
typedef struct {
|
|
// TODO: move buf into private_impl? As it is, it looks like users can modify
|
|
// the buf field to point to a different buffer, which can turn the limit and
|
|
// mark fields into dangling pointers.
|
|
puffs_base__buf1* buf;
|
|
// Do not access the private_impl's fields directly. There is no API/ABI
|
|
// compatibility or safety guarantee if you do so.
|
|
struct {
|
|
puffs_base__limit1 limit;
|
|
uint8_t* mark;
|
|
} private_impl;
|
|
} puffs_base__writer1;
|
|
|
|
#endif // PUFFS_BASE_HEADER_H
|