mirror of
https://github.com/ddidderr/wuffs.git
synced 2026-11-19 16: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)
315 lines
9.8 KiB
C
315 lines
9.8 KiB
C
// After editing this file, run "go generate" in this directory.
|
|
|
|
#ifndef PUFFS_BASE_IMPL_H
|
|
#define PUFFS_BASE_IMPL_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.
|
|
|
|
// puffs_base__empty_struct is used when a Puffs function returns an empty
|
|
// struct. In C, if a function f returns void, you can't say "x = f()", but in
|
|
// Puffs, if a function g returns empty, you can say "y = g()".
|
|
typedef struct {
|
|
} puffs_base__empty_struct;
|
|
|
|
#define PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(x) (void)(x)
|
|
|
|
// PUFFS_BASE__MAGIC is a magic number to check that initializers are called.
|
|
// It's not foolproof, given C doesn't automatically zero memory before use,
|
|
// but it should catch 99.99% of cases.
|
|
//
|
|
// Its (non-zero) value is arbitrary, based on md5sum("puffs").
|
|
#define PUFFS_BASE__MAGIC (0xCB3699CCU)
|
|
|
|
// PUFFS_BASE__ALREADY_ZEROED is passed from a container struct's initializer
|
|
// to a containee struct's initializer when the container has already zeroed
|
|
// the containee's memory.
|
|
//
|
|
// Its (non-zero) value is arbitrary, based on md5sum("zeroed").
|
|
#define PUFFS_BASE__ALREADY_ZEROED (0x68602EF1U)
|
|
|
|
// Use switch cases for coroutine suspension points, similar to the technique
|
|
// in https://www.chiark.greenend.org.uk/~sgtatham/coroutines.html
|
|
//
|
|
// We use a trivial macro instead of an explicit assignment and case statement
|
|
// so that clang-format doesn't get confused by the unusual "case"s.
|
|
#define PUFFS_BASE__COROUTINE_SUSPENSION_POINT(n) \
|
|
coro_susp_point = n; \
|
|
case n:;
|
|
|
|
#define PUFFS_BASE__COROUTINE_SUSPENSION_POINT_MAYBE_SUSPEND(n) \
|
|
if (status < 0) { \
|
|
goto exit; \
|
|
} else if (status == 0) { \
|
|
goto ok; \
|
|
} \
|
|
coro_susp_point = n; \
|
|
goto suspend; \
|
|
case n:;
|
|
|
|
// Clang also defines "__GNUC__".
|
|
#if defined(__GNUC__)
|
|
#define PUFFS_BASE__LIKELY(expr) (__builtin_expect(!!(expr), 1))
|
|
#define PUFFS_BASE__UNLIKELY(expr) (__builtin_expect(!!(expr), 0))
|
|
// Declare the printf prototype. The generated code shouldn't need this at all,
|
|
// but it's useful for manual printf debugging.
|
|
extern int printf(const char* __restrict __format, ...);
|
|
#else
|
|
#define PUFFS_BASE__LIKELY(expr) (expr)
|
|
#define PUFFS_BASE__UNLIKELY(expr) (expr)
|
|
#endif
|
|
|
|
// ---------------- Static Inline Functions
|
|
//
|
|
// The helpers below are functions, instead of macros, because their arguments
|
|
// can be an expression that we shouldn't evaluate more than once.
|
|
//
|
|
// They are in base-impl.h and hence copy/pasted into every generated C file,
|
|
// instead of being in some "base.c" file, since a design goal is that users of
|
|
// the generated C code can often just #include a single .c file, such as
|
|
// "gif.c", without having to additionally include or otherwise build and link
|
|
// a "base.c" file.
|
|
//
|
|
// They are static, so that linking multiple puffs .o files won't complain about
|
|
// duplicate function definitions.
|
|
//
|
|
// They are explicitly marked inline, even if modern compilers don't use the
|
|
// inline attribute to guide optimizations such as inlining, to avoid the
|
|
// -Wunused-function warning, and we like to compile with -Wall -Werror.
|
|
|
|
static inline uint16_t puffs_base__load_u16be(uint8_t* p) {
|
|
return ((uint16_t)(p[0]) << 8) | ((uint16_t)(p[1]) << 0);
|
|
}
|
|
|
|
static inline uint16_t puffs_base__load_u16le(uint8_t* p) {
|
|
return ((uint16_t)(p[0]) << 0) | ((uint16_t)(p[1]) << 8);
|
|
}
|
|
|
|
static inline uint32_t puffs_base__load_u32be(uint8_t* p) {
|
|
return ((uint32_t)(p[0]) << 24) | ((uint32_t)(p[1]) << 16) |
|
|
((uint32_t)(p[2]) << 8) | ((uint32_t)(p[3]) << 0);
|
|
}
|
|
|
|
static inline uint32_t puffs_base__load_u32le(uint8_t* p) {
|
|
return ((uint32_t)(p[0]) << 0) | ((uint32_t)(p[1]) << 8) |
|
|
((uint32_t)(p[2]) << 16) | ((uint32_t)(p[3]) << 24);
|
|
}
|
|
|
|
static inline puffs_base__slice_u8 puffs_base__slice_u8__subslice_i(
|
|
puffs_base__slice_u8 s,
|
|
uint64_t i) {
|
|
if ((i <= SIZE_MAX) && (i <= s.len)) {
|
|
return ((puffs_base__slice_u8){
|
|
.ptr = s.ptr + i,
|
|
.len = s.len - i,
|
|
});
|
|
}
|
|
return ((puffs_base__slice_u8){});
|
|
}
|
|
|
|
static inline puffs_base__slice_u8 puffs_base__slice_u8__subslice_j(
|
|
puffs_base__slice_u8 s,
|
|
uint64_t j) {
|
|
if ((j <= SIZE_MAX) && (j <= s.len)) {
|
|
return ((puffs_base__slice_u8){.ptr = s.ptr, .len = j});
|
|
}
|
|
return ((puffs_base__slice_u8){});
|
|
}
|
|
|
|
static inline puffs_base__slice_u8 puffs_base__slice_u8__subslice_ij(
|
|
puffs_base__slice_u8 s,
|
|
uint64_t i,
|
|
uint64_t j) {
|
|
if ((i <= j) && (j <= SIZE_MAX) && (j <= s.len)) {
|
|
return ((puffs_base__slice_u8){
|
|
.ptr = s.ptr + i,
|
|
.len = j - i,
|
|
});
|
|
}
|
|
return ((puffs_base__slice_u8){});
|
|
}
|
|
|
|
// puffs_base__slice_u8__prefix returns up to the first up_to bytes of s.
|
|
static inline puffs_base__slice_u8 puffs_base__slice_u8__prefix(
|
|
puffs_base__slice_u8 s,
|
|
uint64_t up_to) {
|
|
if ((uint64_t)(s.len) > up_to) {
|
|
s.len = up_to;
|
|
}
|
|
return s;
|
|
}
|
|
|
|
// puffs_base__slice_u8__suffix returns up to the last up_to bytes of s.
|
|
static inline puffs_base__slice_u8 puffs_base__slice_u8_suffix(
|
|
puffs_base__slice_u8 s,
|
|
uint64_t up_to) {
|
|
if ((uint64_t)(s.len) > up_to) {
|
|
s.ptr += (uint64_t)(s.len) - up_to;
|
|
s.len = up_to;
|
|
}
|
|
return s;
|
|
}
|
|
|
|
// puffs_base__slice_u8__copy_from_slice calls memmove(dst.ptr, src.ptr,
|
|
// length) where length is the minimum of dst.len and src.len.
|
|
//
|
|
// Passing a puffs_base__slice_u8 with all fields NULL or zero (a valid, empty
|
|
// slice) is valid and results in a no-op.
|
|
static inline uint64_t puffs_base__slice_u8__copy_from_slice(
|
|
puffs_base__slice_u8 dst,
|
|
puffs_base__slice_u8 src) {
|
|
size_t length = dst.len < src.len ? dst.len : src.len;
|
|
if (length > 0) {
|
|
memmove(dst.ptr, src.ptr, length);
|
|
}
|
|
return length;
|
|
}
|
|
|
|
static inline uint32_t puffs_base__writer1__copy_from_history32(
|
|
uint8_t** ptr_ptr,
|
|
uint8_t* start, // May be NULL, meaning an unmarked writer1.
|
|
uint8_t* end,
|
|
uint32_t distance,
|
|
uint32_t length) {
|
|
if (!start) {
|
|
return 0;
|
|
}
|
|
uint8_t* ptr = *ptr_ptr;
|
|
size_t d = ptr - start;
|
|
if ((d == 0) || (d < (size_t)(distance))) {
|
|
return 0;
|
|
}
|
|
start = ptr - distance;
|
|
size_t n = end - ptr;
|
|
if ((size_t)(length) > n) {
|
|
length = n;
|
|
} else {
|
|
n = length;
|
|
}
|
|
// TODO: is manual unrolling actually helpful?
|
|
for (; n >= 8; n -= 8) {
|
|
*ptr++ = *start++;
|
|
*ptr++ = *start++;
|
|
*ptr++ = *start++;
|
|
*ptr++ = *start++;
|
|
*ptr++ = *start++;
|
|
*ptr++ = *start++;
|
|
*ptr++ = *start++;
|
|
*ptr++ = *start++;
|
|
}
|
|
for (; n; n--) {
|
|
*ptr++ = *start++;
|
|
}
|
|
*ptr_ptr = ptr;
|
|
return length;
|
|
}
|
|
|
|
static inline uint32_t puffs_base__writer1__copy_from_reader32(
|
|
uint8_t** ptr_wptr,
|
|
uint8_t* wend,
|
|
uint8_t** ptr_rptr,
|
|
uint8_t* rend,
|
|
uint32_t length) {
|
|
uint8_t* wptr = *ptr_wptr;
|
|
size_t n = length;
|
|
if (n > wend - wptr) {
|
|
n = wend - wptr;
|
|
}
|
|
uint8_t* rptr = *ptr_rptr;
|
|
if (n > rend - rptr) {
|
|
n = rend - rptr;
|
|
}
|
|
if (n > 0) {
|
|
memmove(wptr, rptr, n);
|
|
*ptr_wptr += n;
|
|
*ptr_rptr += n;
|
|
}
|
|
return n;
|
|
}
|
|
|
|
static inline uint64_t puffs_base__writer1__copy_from_slice(
|
|
uint8_t** ptr_wptr,
|
|
uint8_t* wend,
|
|
puffs_base__slice_u8 src) {
|
|
uint8_t* wptr = *ptr_wptr;
|
|
size_t n = src.len;
|
|
if (n > wend - wptr) {
|
|
n = wend - wptr;
|
|
}
|
|
if (n > 0) {
|
|
memmove(wptr, src.ptr, n);
|
|
*ptr_wptr += n;
|
|
}
|
|
return n;
|
|
}
|
|
|
|
static inline uint32_t puffs_base__writer1__copy_from_slice32(
|
|
uint8_t** ptr_wptr,
|
|
uint8_t* wend,
|
|
puffs_base__slice_u8 src,
|
|
uint32_t length) {
|
|
uint8_t* wptr = *ptr_wptr;
|
|
size_t n = src.len;
|
|
if (n > length) {
|
|
n = length;
|
|
}
|
|
if (n > wend - wptr) {
|
|
n = wend - wptr;
|
|
}
|
|
if (n > 0) {
|
|
memmove(wptr, src.ptr, n);
|
|
*ptr_wptr += n;
|
|
}
|
|
return n;
|
|
}
|
|
|
|
// Note that the *__limit and *__mark methods are private (in base-impl.h) not
|
|
// public (in base-header.h). We assume that, at the boundary between user code
|
|
// and Puffs code, the reader1 and writer1's private_impl fields (including
|
|
// limit and mark) are NULL. Otherwise, some internal assumptions break down.
|
|
// For example, limits could be represented as pointers, even though
|
|
// conceptually they are counts, but that pointer-to-count correspondence
|
|
// becomes invalid if a buffer is re-used (e.g. on resuming a coroutine).
|
|
//
|
|
// Admittedly, some of the Puffs test code calls these methods, but that test
|
|
// code is still Puffs code, not user code. Other Puffs test code modifies
|
|
// private_impl fields directly.
|
|
|
|
static inline puffs_base__reader1 puffs_base__reader1__limit(
|
|
puffs_base__reader1* o,
|
|
uint64_t* ptr_to_len) {
|
|
puffs_base__reader1 ret = *o;
|
|
ret.private_impl.limit.ptr_to_len = ptr_to_len;
|
|
ret.private_impl.limit.next = &o->private_impl.limit;
|
|
return ret;
|
|
}
|
|
|
|
static inline puffs_base__empty_struct puffs_base__reader1__mark(
|
|
puffs_base__reader1* o,
|
|
uint8_t* mark) {
|
|
o->private_impl.mark = mark;
|
|
return ((puffs_base__empty_struct){});
|
|
}
|
|
|
|
// TODO: static inline puffs_base__writer1 puffs_base__writer1__limit()
|
|
|
|
static inline puffs_base__empty_struct puffs_base__writer1__mark(
|
|
puffs_base__writer1* o,
|
|
uint8_t* mark) {
|
|
o->private_impl.mark = mark;
|
|
return ((puffs_base__empty_struct){});
|
|
}
|
|
|
|
#endif // PUFFS_BASE_IMPL_H
|