diff --git a/cmd/puffs-gen-c/base-header.h b/cmd/puffs-gen-c/base-header.h index e6183ae6..729d89e7 100644 --- a/cmd/puffs-gen-c/base-header.h +++ b/cmd/puffs-gen-c/base-header.h @@ -46,19 +46,25 @@ typedef struct { bool closed; // No further writes are expected. } puffs_base_buf1; -typedef struct puffs_base_limit { - uint64_t* len; - struct puffs_base_limit* next; -} puffs_base_limit; +// 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_limit limit; + puffs_base_limit1 limit; } puffs_base_reader1; typedef struct { puffs_base_buf1* buf; - puffs_base_limit limit; + puffs_base_limit1 limit; } puffs_base_writer1; #endif // PUFFS_BASE_HEADER_H diff --git a/cmd/puffs-gen-c/data.go b/cmd/puffs-gen-c/data.go index 2daf4287..1d268861 100644 --- a/cmd/puffs-gen-c/data.go +++ b/cmd/puffs-gen-c/data.go @@ -7,7 +7,8 @@ package main const baseHeader = "" + "#ifndef PUFFS_BASE_HEADER_H\n#define PUFFS_BASE_HEADER_H\n\n// Use of this source code is governed by a BSD-style license that can be found\n// in the LICENSE file.\n\n#include \n#include \n#include \n\n// Puffs requires a word size of at least 32 bits because it assumes that\n// converting a u32 to usize will never overflow. For example, the size of a\n// decoded image is often represented, explicitly or implicitly in an image\n// file, as a u32, and it is convenient to compare that to a buffer size.\n//\n// Similarly, the word size is at most 64 bits because it assumes that\n// converting a usize to u64 will never overflow.\n#if __WORDSIZE < 32\n#error \"Puffs requires a word size of at least 32 bits\"\n#elif __WORDSIZE > 64\n#error \"Puffs requires a word size of at most 64 bits\"\n#endif\n\n// PUFFS_VERSION is the major.minor version number as a uint32. The major\n// number is the high 16 bits. The minor number is the low 16 bits.\n//\n// The intention is to bump the version number at least on every API " + - "/ ABI\n// backwards incompatible change.\n//\n// For now, the API and ABI are simply unstable and can change at any time.\n//\n// TODO: don't hard code this in base-header.h.\n#define PUFFS_VERSION (0x00001)\n\n// puffs_base_buf1 is a 1-dimensional buffer (a pointer and length) plus\n// additional indexes into that buffer.\n//\n// A value with all fields NULL or zero is a valid, empty buffer.\ntypedef struct {\n uint8_t* ptr; // Pointer.\n size_t len; // Length.\n size_t wi; // Write index. Invariant: wi <= len.\n size_t ri; // Read index. Invariant: ri <= wi.\n bool closed; // No further writes are expected.\n} puffs_base_buf1;\n\ntypedef struct puffs_base_limit {\n uint64_t* len;\n struct puffs_base_limit* next;\n} puffs_base_limit;\n\ntypedef struct {\n puffs_base_buf1* buf;\n puffs_base_limit limit;\n} puffs_base_reader1;\n\ntypedef struct {\n puffs_base_buf1* buf;\n puffs_base_limit limit;\n} puffs_base_writer1;\n\n#endif // PUFFS_BASE_HEADER_H\n" + + "/ ABI\n// backwards incompatible change.\n//\n// For now, the API and ABI are simply unstable and can change at any time.\n//\n// TODO: don't hard code this in base-header.h.\n#define PUFFS_VERSION (0x00001)\n\n// puffs_base_buf1 is a 1-dimensional buffer (a pointer and length) plus\n// additional indexes into that buffer.\n//\n// A value with all fields NULL or zero is a valid, empty buffer.\ntypedef struct {\n uint8_t* ptr; // Pointer.\n size_t len; // Length.\n size_t wi; // Write index. Invariant: wi <= len.\n size_t ri; // Read index. Invariant: ri <= wi.\n bool closed; // No further writes are expected.\n} puffs_base_buf1;\n\n// puffs_base_limit1 provides a limited view of a 1-dimensional byte stream:\n// its first N bytes. That N can be greater than a buffer's current read or\n// write capacity. N decreases naturally over time as bytes are read from or\n// written to the stream.\n//\n// A value with all fields NULL or zero is a valid, unlimited view.\ntypedef struct puffs_base_limit1 {\n uint64_t* ptr_to_len" + + "; // Pointer to N.\n struct puffs_base_limit1* next; // Linked list of limits.\n} puffs_base_limit1;\n\ntypedef struct {\n puffs_base_buf1* buf;\n puffs_base_limit1 limit;\n} puffs_base_reader1;\n\ntypedef struct {\n puffs_base_buf1* buf;\n puffs_base_limit1 limit;\n} puffs_base_writer1;\n\n#endif // PUFFS_BASE_HEADER_H\n" + "" const baseImpl = "" + diff --git a/cmd/puffs-gen-c/main.go b/cmd/puffs-gen-c/main.go index 2085f3a0..c60a1998 100644 --- a/cmd/puffs-gen-c/main.go +++ b/cmd/puffs-gen-c/main.go @@ -990,7 +990,8 @@ func (g *gen) writeCallSuspendibles(n *a.Expr, depth uint32) error { // TODO: suspend coroutine state. // // TODO: loop over all limits, not just the first one. - g.printf("if ((%ssrc.buf->ri >= %ssrc.buf->wi) || (%ssrc.limit.len && (*%ssrc.limit.len == 0))) {", + g.printf("if ((%ssrc.buf->ri >= %ssrc.buf->wi) || "+ + "(%ssrc.limit.ptr_to_len && (*%ssrc.limit.ptr_to_len == 0))) {", aPrefix, aPrefix, aPrefix, aPrefix) g.printf("status = ((%ssrc.buf->closed) && (%ssrc.buf->ri == %ssrc.buf->wi)) ?"+ "puffs_%s_error_unexpected_eof : puffs_%s_status_short_read;", @@ -1007,7 +1008,7 @@ func (g *gen) writeCallSuspendibles(n *a.Expr, depth uint32) error { return err } g.printf(" = %ssrc.buf->ptr[%ssrc.buf->ri++];\n", aPrefix, aPrefix) - g.printf("if (%ssrc.limit.len) { (*%ssrc.limit.len)--; }\n", aPrefix, aPrefix) + g.printf("if (%ssrc.limit.ptr_to_len) { (*%ssrc.limit.ptr_to_len)--; }\n", aPrefix, aPrefix) } else if isInSrc(g.tm, n, t.KeySkip32, 1) { if g.perFunc.tempW > maxTemp { @@ -1243,8 +1244,8 @@ func (g *gen) writeExprOther(n *a.Expr, rp replacementPolicy, depth uint32) erro // TODO: don't hard code so much detail. g.writes("(puffs_base_reader1) {") g.writes(".buf = a_src.buf,") - g.writes(".limit = (puffs_base_limit) {") - g.printf(".len = &%s%s,", lPrefix, g.perFunc.limitVarName) + g.writes(".limit = (puffs_base_limit1) {") + g.printf(".ptr_to_len = &%s%s,", lPrefix, g.perFunc.limitVarName) g.writes(".next = &a_src.limit,") g.writes("}}") g.perFunc.limitVarName = "" diff --git a/gen/c/std/gif.c b/gen/c/std/gif.c index bd183541..4ab18080 100644 --- a/gen/c/std/gif.c +++ b/gen/c/std/gif.c @@ -49,19 +49,25 @@ typedef struct { bool closed; // No further writes are expected. } puffs_base_buf1; -typedef struct puffs_base_limit { - uint64_t* len; - struct puffs_base_limit* next; -} puffs_base_limit; +// 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_limit limit; + puffs_base_limit1 limit; } puffs_base_reader1; typedef struct { puffs_base_buf1* buf; - puffs_base_limit limit; + puffs_base_limit1 limit; } puffs_base_writer1; #endif // PUFFS_BASE_HEADER_H @@ -338,15 +344,15 @@ puffs_gif_status puffs_gif_decoder_decode(puffs_gif_decoder* self, } while (true) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; goto cleanup0; } uint8_t t_0 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_c = t_0; if (v_c == 33) { @@ -386,15 +392,15 @@ puffs_gif_status puffs_gif_decoder_decode_header(puffs_gif_decoder* self, v_i = 0; while (v_i < 6) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_0 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_c[v_i] = t_0; v_i += 1; @@ -421,15 +427,15 @@ puffs_gif_status puffs_gif_decoder_decode_lsd(puffs_gif_decoder* self, v_i = 0; while (v_i < 7) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_0 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_c[v_i] = t_0; v_i += 1; @@ -444,39 +450,39 @@ puffs_gif_status puffs_gif_decoder_decode_lsd(puffs_gif_decoder* self, v_i = 0; while (v_i < v_gct_size) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_1 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } self->private_impl.f_gct[(3 * v_i) + 0] = t_1; if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_2 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } self->private_impl.f_gct[(3 * v_i) + 1] = t_2; if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_3 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } self->private_impl.f_gct[(3 * v_i) + 2] = t_3; v_i += 1; @@ -494,15 +500,15 @@ puffs_gif_status puffs_gif_decoder_decode_extension(puffs_gif_decoder* self, uint8_t v_block_size; if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_0 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_label = t_0; if (v_label == 1) { @@ -514,15 +520,15 @@ puffs_gif_status puffs_gif_decoder_decode_extension(puffs_gif_decoder* self, } while (true) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_1 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_block_size = t_1; if (v_block_size == 0) { @@ -562,15 +568,15 @@ puffs_gif_status puffs_gif_decoder_decode_id(puffs_gif_decoder* self, v_i = 0; while (v_i < 9) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_0 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_c[v_i] = t_0; v_i += 1; @@ -582,15 +588,15 @@ puffs_gif_status puffs_gif_decoder_decode_id(puffs_gif_decoder* self, return puffs_gif_error_todo_unsupported_local_color_table; } if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_1 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_lw = t_1; if ((v_lw < 2) || (8 < v_lw)) { @@ -600,15 +606,15 @@ puffs_gif_status puffs_gif_decoder_decode_id(puffs_gif_decoder* self, ((uint32_t)(v_lw))); while (true) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; return status; } uint8_t t_2 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_block_size = t_2; if (v_block_size == 0) { @@ -617,8 +623,8 @@ puffs_gif_status puffs_gif_decoder_decode_id(puffs_gif_decoder* self, l_lzw_src = ((uint64_t)(v_block_size)); v_lzw_src = (puffs_base_reader1){.buf = a_src.buf, - .limit = (puffs_base_limit){ - .len = &l_lzw_src, .next = &a_src.limit, + .limit = (puffs_base_limit1){ + .ptr_to_len = &l_lzw_src, .next = &a_src.limit, }}; status = puffs_gif_lzw_decoder_decode(&self->private_impl.f_lzw, a_dst, v_lzw_src); @@ -690,15 +696,15 @@ label_0_continue:; while (true) { while (v_n_bits < v_width) { if ((a_src.buf->ri >= a_src.buf->wi) || - (a_src.limit.len && (*a_src.limit.len == 0))) { + (a_src.limit.ptr_to_len && (*a_src.limit.ptr_to_len == 0))) { status = ((a_src.buf->closed) && (a_src.buf->ri == a_src.buf->wi)) ? puffs_gif_error_unexpected_eof : puffs_gif_status_short_read; goto cleanup0; } uint8_t t_0 = a_src.buf->ptr[a_src.buf->ri++]; - if (a_src.limit.len) { - (*a_src.limit.len)--; + if (a_src.limit.ptr_to_len) { + (*a_src.limit.ptr_to_len)--; } v_bits |= (((uint32_t)(t_0)) << v_n_bits); v_n_bits += 8; diff --git a/gen/h/std/gif.h b/gen/h/std/gif.h index 84c586a9..4f198ffd 100644 --- a/gen/h/std/gif.h +++ b/gen/h/std/gif.h @@ -49,19 +49,25 @@ typedef struct { bool closed; // No further writes are expected. } puffs_base_buf1; -typedef struct puffs_base_limit { - uint64_t* len; - struct puffs_base_limit* next; -} puffs_base_limit; +// 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_limit limit; + puffs_base_limit1 limit; } puffs_base_reader1; typedef struct { puffs_base_buf1* buf; - puffs_base_limit limit; + puffs_base_limit1 limit; } puffs_base_writer1; #endif // PUFFS_BASE_HEADER_H