#ifndef PUFFS_FLATE_H #define PUFFS_FLATE_H // Code generated by puffs-gen-c. DO NOT EDIT. #ifndef PUFFS_BASE_HEADER_H #define PUFFS_BASE_HEADER_H // Use of this source code is governed by a BSD-style license that can be found // in the LICENSE file. #include #include #include // 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_base_buf1 is a 1-dimensional buffer (a pointer and length) plus // additional indexes into that buffer. // // 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; typedef struct { puffs_base_buf1* buf; puffs_base_limit1 limit; } puffs_base_reader1; typedef struct { puffs_base_buf1* buf; puffs_base_limit1 limit; } puffs_base_writer1; #endif // PUFFS_BASE_HEADER_H #ifdef __cplusplus extern "C" { #endif // ---------------- Status Codes // Status codes are int32_t values: // - the sign bit indicates a non-recoverable status code: an error // - bits 10-30 hold the packageid: a namespace // - bits 8-9 are reserved // - bits 0-7 are a package-namespaced numeric code // // Do not manipulate these bits directly. Use the API functions such as // puffs_flate_status_is_error instead. typedef int32_t puffs_flate_status; #define puffs_flate_packageid 967230 // 0x000ec23e #define PUFFS_FLATE_STATUS_OK 0 // 0x00000000 #define PUFFS_FLATE_ERROR_BAD_PUFFS_VERSION -2147483647 // 0x80000001 #define PUFFS_FLATE_ERROR_BAD_RECEIVER -2147483646 // 0x80000002 #define PUFFS_FLATE_ERROR_BAD_ARGUMENT -2147483645 // 0x80000003 #define PUFFS_FLATE_ERROR_CONSTRUCTOR_NOT_CALLED -2147483644 // 0x80000004 #define PUFFS_FLATE_ERROR_UNEXPECTED_EOF -2147483643 // 0x80000005 #define PUFFS_FLATE_SUSPENSION_SHORT_READ 6 // 0x00000006 #define PUFFS_FLATE_SUSPENSION_SHORT_WRITE 7 // 0x00000007 #define PUFFS_FLATE_ERROR_CLOSED_FOR_WRITES -2147483640 // 0x80000008 #define PUFFS_FLATE_ERROR_BAD_FLATE_BLOCK -1157040128 // 0xbb08f800 #define PUFFS_FLATE_ERROR_INCONSISTENT_STORED_BLOCK_LENGTH \ -1157040127 // 0xbb08f801 #define PUFFS_FLATE_ERROR_INTERNAL_ERROR_INCONSISTENT_N_BITS \ -1157040126 // 0xbb08f802 #define PUFFS_FLATE_ERROR_TODO_FIXED_HUFFMAN_BLOCKS -1157040125 // 0xbb08f803 #define PUFFS_FLATE_ERROR_TODO_DYNAMIC_HUFFMAN_BLOCKS -1157040124 // 0xbb08f804 bool puffs_flate_status_is_error(puffs_flate_status s); const char* puffs_flate_status_string(puffs_flate_status s); // ---------------- Structs typedef struct { // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. Instead, use the // puffs_flate_decoder_etc functions. // // In C++, these fields would be "private", but C does not support that. // // It is a struct, not a struct*, so that it can be stack allocated. struct { puffs_flate_status status; uint32_t magic; uint64_t scratch; uint32_t f_bits; uint32_t f_n_bits; struct { uint32_t coro_susp_point; uint32_t v_final; uint32_t v_type; } c_decode[1]; struct { uint32_t coro_susp_point; uint8_t v_n0; uint8_t v_n1; uint8_t v_complement; } c_decode_uncompressed[1]; } private_impl; } puffs_flate_decoder; // ---------------- Public Constructor and Destructor Prototypes // puffs_flate_decoder_constructor is a constructor function. // // It should be called before any other puffs_flate_decoder_* function. // // Pass PUFFS_VERSION and 0 for puffs_version and for_internal_use_only. void puffs_flate_decoder_constructor(puffs_flate_decoder* self, uint32_t puffs_version, uint32_t for_internal_use_only); void puffs_flate_decoder_destructor(puffs_flate_decoder* self); // ---------------- Public Function Prototypes puffs_flate_status puffs_flate_decoder_decode(puffs_flate_decoder* self, puffs_base_writer1 a_dst, puffs_base_reader1 a_src); puffs_flate_status puffs_flate_decoder_decode_uncompressed( puffs_flate_decoder* self, puffs_base_writer1 a_dst, puffs_base_reader1 a_src); #ifdef __cplusplus } // extern "C" #endif #endif // PUFFS_FLATE_H // C HEADER ENDS HERE. #ifndef PUFFS_BASE_IMPL_H #define PUFFS_BASE_IMPL_H // Use of this source code is governed by a BSD-style license that can be found // in the LICENSE file. // 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_COROUTINE_SUSPENSION_POINT(n) \ coro_susp_point = n; \ case n: // Clang also defines "__GNUC__". #if defined(__GNUC__) #define PUFFS_LIKELY(expr) (__builtin_expect(!!(expr), 1)) #define PUFFS_UNLIKELY(expr) (__builtin_expect(!!(expr), 0)) #else #define PUFFS_LIKELY(expr) (expr) #define PUFFS_UNLIKELY(expr) (expr) #endif #endif // PUFFS_BASE_IMPL_H // ---------------- Status Codes Implementations bool puffs_flate_status_is_error(puffs_flate_status s) { return s < 0; } const char* puffs_flate_status_strings0[9] = { "flate: ok", "flate: bad puffs version", "flate: bad receiver", "flate: bad argument", "flate: constructor not called", "flate: unexpected EOF", "flate: short read", "flate: short write", "flate: closed for writes", }; const char* puffs_flate_status_strings1[5] = { "flate: bad flate block", "flate: inconsistent stored block length", "flate: internal error: inconsistent n_bits", "flate: TODO: fixed Huffman blocks", "flate: TODO: dynamic Huffman blocks", }; const char* puffs_flate_status_string(puffs_flate_status s) { const char** a = NULL; uint32_t n = 0; switch ((s >> 10) & 0x1fffff) { case 0: a = puffs_flate_status_strings0; n = 9; break; case puffs_flate_packageid: a = puffs_flate_status_strings1; n = 5; break; } uint32_t i = s & 0xff; return i < n ? a[i] : "flate: unknown status"; } // ---------------- Private Constructor and Destructor Prototypes // ---------------- Private Function Prototypes // ---------------- Constructor and Destructor Implementations // PUFFS_MAGIC is a magic number to check that constructors 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_MAGIC (0xCB3699CCU) // PUFFS_ALREADY_ZEROED is passed from a container struct's constructor to a // containee struct's constructor when the container has already zeroed the // containee's memory. // // Its (non-zero) value is arbitrary, based on md5sum("zeroed"). #define PUFFS_ALREADY_ZEROED (0x68602EF1U) void puffs_flate_decoder_constructor(puffs_flate_decoder* self, uint32_t puffs_version, uint32_t for_internal_use_only) { if (!self) { return; } if (puffs_version != PUFFS_VERSION) { self->private_impl.status = PUFFS_FLATE_ERROR_BAD_PUFFS_VERSION; return; } if (for_internal_use_only != PUFFS_ALREADY_ZEROED) { memset(self, 0, sizeof(*self)); } self->private_impl.magic = PUFFS_MAGIC; } void puffs_flate_decoder_destructor(puffs_flate_decoder* self) { if (!self) { return; } } // ---------------- Function Implementations puffs_flate_status puffs_flate_decoder_decode(puffs_flate_decoder* self, puffs_base_writer1 a_dst, puffs_base_reader1 a_src) { if (!self) { return PUFFS_FLATE_ERROR_BAD_RECEIVER; } if (self->private_impl.magic != PUFFS_MAGIC) { self->private_impl.status = PUFFS_FLATE_ERROR_CONSTRUCTOR_NOT_CALLED; } if (self->private_impl.status < 0) { return self->private_impl.status; } puffs_flate_status status = PUFFS_FLATE_STATUS_OK; uint32_t v_final; uint32_t v_type; uint8_t* b_rptr_src = NULL; uint8_t* b_rend_src = NULL; if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; size_t len = a_src.buf->wi - a_src.buf->ri; puffs_base_limit1* lim; for (lim = &a_src.limit; lim; lim = lim->next) { if (lim->ptr_to_len && (len > *lim->ptr_to_len)) { len = *lim->ptr_to_len; } } b_rend_src = b_rptr_src + len; } uint32_t coro_susp_point = self->private_impl.c_decode[0].coro_susp_point; if (coro_susp_point) { v_final = self->private_impl.c_decode[0].v_final; v_type = self->private_impl.c_decode[0].v_type; } switch (coro_susp_point) { PUFFS_COROUTINE_SUSPENSION_POINT(0); while (true) { while (self->private_impl.f_n_bits < 3) { PUFFS_COROUTINE_SUSPENSION_POINT(1); if (PUFFS_UNLIKELY(b_rptr_src == b_rend_src)) { goto short_read_src; } uint8_t t_0 = *b_rptr_src++; self->private_impl.f_bits |= (((uint32_t)(t_0)) << self->private_impl.f_n_bits); self->private_impl.f_n_bits += 8; } v_final = (self->private_impl.f_bits & 1); v_type = ((self->private_impl.f_bits >> 1) & 3); self->private_impl.f_bits >>= 3; self->private_impl.f_n_bits -= 3; if (v_type == 0) { PUFFS_COROUTINE_SUSPENSION_POINT(2); if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; puffs_base_limit1* lim; for (lim = &a_src.limit; lim; lim = lim->next) { if (lim->ptr_to_len) { *lim->ptr_to_len -= n; } } } status = puffs_flate_decoder_decode_uncompressed(self, a_dst, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; size_t len = a_src.buf->wi - a_src.buf->ri; puffs_base_limit1* lim; for (lim = &a_src.limit; lim; lim = lim->next) { if (lim->ptr_to_len && (len > *lim->ptr_to_len)) { len = *lim->ptr_to_len; } } b_rend_src = b_rptr_src + len; } if (status) { goto suspend; } } else if (v_type == 1) { status = PUFFS_FLATE_ERROR_TODO_FIXED_HUFFMAN_BLOCKS; goto suspend; } else if (v_type == 2) { status = PUFFS_FLATE_ERROR_TODO_DYNAMIC_HUFFMAN_BLOCKS; goto suspend; } else { status = PUFFS_FLATE_ERROR_BAD_FLATE_BLOCK; goto suspend; } if (v_final != 0) { status = PUFFS_FLATE_STATUS_OK; goto suspend; } } coro_susp_point = 0; } goto suspend; suspend: self->private_impl.c_decode[0].coro_susp_point = coro_susp_point; self->private_impl.c_decode[0].v_final = v_final; self->private_impl.c_decode[0].v_type = v_type; if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; puffs_base_limit1* lim; for (lim = &a_src.limit; lim; lim = lim->next) { if (lim->ptr_to_len) { *lim->ptr_to_len -= n; } } } goto exit; exit: self->private_impl.status = status; return status; short_read_src: status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? PUFFS_FLATE_ERROR_UNEXPECTED_EOF : PUFFS_FLATE_SUSPENSION_SHORT_READ; goto suspend; } puffs_flate_status puffs_flate_decoder_decode_uncompressed( puffs_flate_decoder* self, puffs_base_writer1 a_dst, puffs_base_reader1 a_src) { if (!self) { return PUFFS_FLATE_ERROR_BAD_RECEIVER; } if (self->private_impl.magic != PUFFS_MAGIC) { self->private_impl.status = PUFFS_FLATE_ERROR_CONSTRUCTOR_NOT_CALLED; } if (self->private_impl.status < 0) { return self->private_impl.status; } puffs_flate_status status = PUFFS_FLATE_STATUS_OK; uint8_t v_n0; uint8_t v_n1; uint8_t v_complement; uint8_t* b_wptr_dst = NULL; uint8_t* b_wend_dst = NULL; if (a_dst.buf) { b_wptr_dst = a_dst.buf->ptr + a_dst.buf->wi; size_t len = a_dst.buf->len - a_dst.buf->wi; puffs_base_limit1* lim; for (lim = &a_dst.limit; lim; lim = lim->next) { if (lim->ptr_to_len && (len > *lim->ptr_to_len)) { len = *lim->ptr_to_len; } } b_wend_dst = b_wptr_dst + len; } uint8_t* b_rptr_src = NULL; uint8_t* b_rend_src = NULL; if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; size_t len = a_src.buf->wi - a_src.buf->ri; puffs_base_limit1* lim; for (lim = &a_src.limit; lim; lim = lim->next) { if (lim->ptr_to_len && (len > *lim->ptr_to_len)) { len = *lim->ptr_to_len; } } b_rend_src = b_rptr_src + len; } uint32_t coro_susp_point = self->private_impl.c_decode_uncompressed[0].coro_susp_point; if (coro_susp_point) { v_n0 = self->private_impl.c_decode_uncompressed[0].v_n0; v_n1 = self->private_impl.c_decode_uncompressed[0].v_n1; v_complement = self->private_impl.c_decode_uncompressed[0].v_complement; } switch (coro_susp_point) { PUFFS_COROUTINE_SUSPENSION_POINT(0); if (self->private_impl.f_n_bits >= 8) { status = PUFFS_FLATE_ERROR_INTERNAL_ERROR_INCONSISTENT_N_BITS; goto suspend; } self->private_impl.f_n_bits = 0; PUFFS_COROUTINE_SUSPENSION_POINT(1); if (PUFFS_UNLIKELY(b_rptr_src == b_rend_src)) { goto short_read_src; } uint8_t t_0 = *b_rptr_src++; v_n0 = t_0; PUFFS_COROUTINE_SUSPENSION_POINT(2); if (PUFFS_UNLIKELY(b_rptr_src == b_rend_src)) { goto short_read_src; } uint8_t t_1 = *b_rptr_src++; v_n1 = t_1; v_complement = 0; PUFFS_COROUTINE_SUSPENSION_POINT(3); if (PUFFS_UNLIKELY(b_rptr_src == b_rend_src)) { goto short_read_src; } uint8_t t_2 = *b_rptr_src++; v_complement = t_2; if ((255 - v_complement) != v_n0) { status = PUFFS_FLATE_ERROR_INCONSISTENT_STORED_BLOCK_LENGTH; goto suspend; } PUFFS_COROUTINE_SUSPENSION_POINT(4); if (PUFFS_UNLIKELY(b_rptr_src == b_rend_src)) { goto short_read_src; } uint8_t t_3 = *b_rptr_src++; v_complement = t_3; if ((255 - v_complement) != v_n1) { status = PUFFS_FLATE_ERROR_INCONSISTENT_STORED_BLOCK_LENGTH; goto suspend; } PUFFS_COROUTINE_SUSPENSION_POINT(5); { self->private_impl.scratch = ((((uint32_t)(v_n1)) << 8) | ((uint32_t)(v_n0))); PUFFS_COROUTINE_SUSPENSION_POINT(6); size_t t_4 = self->private_impl.scratch; if (t_4 > b_wend_dst - b_wptr_dst) { t_4 = b_wend_dst - b_wptr_dst; status = PUFFS_FLATE_SUSPENSION_SHORT_WRITE; } if (t_4 > b_rend_src - b_rptr_src) { t_4 = b_rend_src - b_rptr_src; status = PUFFS_FLATE_SUSPENSION_SHORT_READ; } memmove(b_wptr_dst, b_rptr_src, t_4); b_wptr_dst += t_4; b_rptr_src += t_4; if (status) { self->private_impl.scratch -= t_4; goto suspend; } } coro_susp_point = 0; } goto suspend; suspend: self->private_impl.c_decode_uncompressed[0].coro_susp_point = coro_susp_point; self->private_impl.c_decode_uncompressed[0].v_n0 = v_n0; self->private_impl.c_decode_uncompressed[0].v_n1 = v_n1; self->private_impl.c_decode_uncompressed[0].v_complement = v_complement; if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; puffs_base_limit1* lim; for (lim = &a_dst.limit; lim; lim = lim->next) { if (lim->ptr_to_len) { *lim->ptr_to_len -= n; } } } if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; puffs_base_limit1* lim; for (lim = &a_src.limit; lim; lim = lim->next) { if (lim->ptr_to_len) { *lim->ptr_to_len -= n; } } } goto exit; exit: self->private_impl.status = status; return status; short_read_src: status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? PUFFS_FLATE_ERROR_UNEXPECTED_EOF : PUFFS_FLATE_SUSPENSION_SHORT_READ; goto suspend; }