diff --git a/cmd/puffs-c/internal/cgen/base-header.h b/cmd/puffs-c/internal/cgen/base-header.h index f8adf13b..282a796a 100644 --- a/cmd/puffs-c/internal/cgen/base-header.h +++ b/cmd/puffs-c/internal/cgen/base-header.h @@ -66,23 +66,27 @@ typedef struct { } puffs_base__buf1; 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } private_impl; } puffs_base__writer1; diff --git a/cmd/puffs-c/internal/cgen/base-impl.h b/cmd/puffs-c/internal/cgen/base-impl.h index 058c91df..933c1e23 100644 --- a/cmd/puffs-c/internal/cgen/base-impl.h +++ b/cmd/puffs-c/internal/cgen/base-impl.h @@ -274,37 +274,65 @@ static inline uint32_t puffs_base__writer1__copy_from_slice32( 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, the limit field is represented as a pointer, even though +// conceptually it is a count, 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__empty_struct puffs_base__reader1__limit( - puffs_base__reader1* r, + puffs_base__reader1* o, + uint8_t* ptr, uint64_t limit) { - if (!r->use_limitt || (r->limitt > limit)) { - r->limitt = limit; - r->use_limitt = true; + if (!o->buf) { + o->private_impl.limit = NULL; + } else { + uint64_t len = o->buf->wi - o->buf->ri; + if (limit > len) { + limit = len; + } + if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) { + o->private_impl.limit = ptr + limit; + } } return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__reader1__mark( - puffs_base__reader1* r, + puffs_base__reader1* o, uint8_t* mark) { - r->private_impl.mark = mark; + o->private_impl.mark = mark; return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__writer1__limit( - puffs_base__writer1* w, + puffs_base__writer1* o, + uint8_t* ptr, uint64_t limit) { - if (!w->use_limitt || (w->limitt > limit)) { - w->limitt = limit; - w->use_limitt = true; + if (!o->buf) { + o->private_impl.limit = NULL; + } else { + uint64_t len = o->buf->len - o->buf->wi; + if (limit > len) { + limit = len; + } + if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) { + o->private_impl.limit = ptr + limit; + } } return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__writer1__mark( - puffs_base__writer1* w, + puffs_base__writer1* o, uint8_t* mark) { - w->private_impl.mark = mark; + o->private_impl.mark = mark; return ((puffs_base__empty_struct){}); } diff --git a/cmd/puffs-c/internal/cgen/data.go b/cmd/puffs-c/internal/cgen/data.go index 8c94ebee..f93ddb95 100644 --- a/cmd/puffs-c/internal/cgen/data.go +++ b/cmd/puffs-c/internal/cgen/data.go @@ -19,8 +19,8 @@ package cgen const baseHeader = "" + "#ifndef PUFFS_BASE_HEADER_H\n#define PUFFS_BASE_HEADER_H\n\n// Copyright 2017 The Puffs Authors.\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// https://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\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// Si" + "milarly, 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__slice_u8 is a 1-dimensional buffer (a pointer and length).\n//\n// A value with all fields NULL or zero is a valid, empty slice.\ntypedef struct {\n uint8_t* ptr;\n size_t len;\n} puffs_base__slice_u8;\n\n// puffs_base__buf1 is a 1-dimensional buffer (a pointer and length), plus\n// additional indexes into that buffer, p" + - "lus an opened / closed flag.\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 {\n puffs_base__buf1* buf;\n uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)?\n bool use_limitt;\n // Do not access the private_impl's fields directly. There is no API/ABI\n // compatibility or safety guarantee if you do so.\n struct {\n uint8_t* mark;\n } private_impl;\n} puffs_base__reader1;\n\ntypedef struct {\n puffs_base__buf1* buf;\n uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)?\n bool use_limitt;\n // Do not access the private_impl's fields directly. There is no API/ABI\n // compatibility or safety guarantee if you do so.\n struct {\n uint8_t* mark;\n } private_impl;\n} puffs_base__writ" + - "er1;\n\n#endif // PUFFS_BASE_HEADER_H\n" + + "lus an opened / closed flag.\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 {\n // TODO: move buf into private_impl? As it is, it looks like users can modify\n // the buf field to point to a different buffer, which can turn the limit and\n // mark fields into dangling pointers.\n puffs_base__buf1* buf;\n // Do not access the private_impl's fields directly. There is no API/ABI\n // compatibility or safety guarantee if you do so.\n struct {\n uint8_t* limit;\n uint8_t* mark;\n } private_impl;\n} puffs_base__reader1;\n\ntypedef struct {\n // TODO: move buf into private_impl? As it is, it looks like users can modify\n // the buf field to point to a different buffer, which can turn the limit and\n // mark fields into dangling" + + " pointers.\n puffs_base__buf1* buf;\n // Do not access the private_impl's fields directly. There is no API/ABI\n // compatibility or safety guarantee if you do so.\n struct {\n uint8_t* limit;\n uint8_t* mark;\n } private_impl;\n} puffs_base__writer1;\n\n#endif // PUFFS_BASE_HEADER_H\n" + "" const baseImpl = "" + @@ -32,8 +32,9 @@ const baseImpl = "" + "_ij(\n puffs_base__slice_u8 s,\n uint64_t i,\n uint64_t j) {\n if ((i <= j) && (j <= SIZE_MAX) && (j <= s.len)) {\n return ((puffs_base__slice_u8){\n .ptr = s.ptr + i,\n .len = j - i,\n });\n }\n return ((puffs_base__slice_u8){});\n}\n\n// puffs_base__slice_u8__prefix returns up to the first up_to bytes of s.\nstatic inline puffs_base__slice_u8 puffs_base__slice_u8__prefix(\n puffs_base__slice_u8 s,\n uint64_t up_to) {\n if ((uint64_t)(s.len) > up_to) {\n s.len = up_to;\n }\n return s;\n}\n\n// puffs_base__slice_u8__suffix returns up to the last up_to bytes of s.\nstatic inline puffs_base__slice_u8 puffs_base__slice_u8_suffix(\n puffs_base__slice_u8 s,\n uint64_t up_to) {\n if ((uint64_t)(s.len) > up_to) {\n s.ptr += (uint64_t)(s.len) - up_to;\n s.len = up_to;\n }\n return s;\n}\n\n// puffs_base__slice_u8__copy_from_slice calls memmove(dst.ptr, src.ptr,\n// length) where length is the minimum of dst.len and src.len.\n//\n// Passing a puffs_base__slice_u8 with all fields NULL or zero (a v" + "alid, empty\n// slice) is valid and results in a no-op.\nstatic inline uint64_t puffs_base__slice_u8__copy_from_slice(\n puffs_base__slice_u8 dst,\n puffs_base__slice_u8 src) {\n size_t length = dst.len < src.len ? dst.len : src.len;\n if (length > 0) {\n memmove(dst.ptr, src.ptr, length);\n }\n return length;\n}\n\nstatic inline uint32_t puffs_base__writer1__copy_from_history32(\n uint8_t** ptr_ptr,\n uint8_t* start, // May be NULL, meaning an unmarked writer1.\n uint8_t* end,\n uint32_t distance,\n uint32_t length) {\n if (!start) {\n return 0;\n }\n uint8_t* ptr = *ptr_ptr;\n size_t d = ptr - start;\n if ((d == 0) || (d < (size_t)(distance))) {\n return 0;\n }\n start = ptr - distance;\n size_t n = end - ptr;\n if ((size_t)(length) > n) {\n length = n;\n } else {\n n = length;\n }\n // TODO: is manual unrolling actually helpful?\n for (; n >= 8; n -= 8) {\n *ptr++ = *start++;\n *ptr++ = *start++;\n *ptr++ = *start++;\n *ptr++ = *start++;\n *ptr++ = *start++;\n *ptr++ = *star" + "t++;\n *ptr++ = *start++;\n *ptr++ = *start++;\n }\n for (; n; n--) {\n *ptr++ = *start++;\n }\n *ptr_ptr = ptr;\n return length;\n}\n\nstatic inline uint32_t puffs_base__writer1__copy_from_reader32(\n uint8_t** ptr_wptr,\n uint8_t* wend,\n uint8_t** ptr_rptr,\n uint8_t* rend,\n uint32_t length) {\n uint8_t* wptr = *ptr_wptr;\n size_t n = length;\n if (n > wend - wptr) {\n n = wend - wptr;\n }\n uint8_t* rptr = *ptr_rptr;\n if (n > rend - rptr) {\n n = rend - rptr;\n }\n if (n > 0) {\n memmove(wptr, rptr, n);\n *ptr_wptr += n;\n *ptr_rptr += n;\n }\n return n;\n}\n\nstatic inline uint64_t puffs_base__writer1__copy_from_slice(\n uint8_t** ptr_wptr,\n uint8_t* wend,\n puffs_base__slice_u8 src) {\n uint8_t* wptr = *ptr_wptr;\n size_t n = src.len;\n if (n > wend - wptr) {\n n = wend - wptr;\n }\n if (n > 0) {\n memmove(wptr, src.ptr, n);\n *ptr_wptr += n;\n }\n return n;\n}\n\nstatic inline uint32_t puffs_base__writer1__copy_from_slice32(\n uint8_t** ptr_wptr,\n uint8_t* wend,\n " + - " puffs_base__slice_u8 src,\n uint32_t length) {\n uint8_t* wptr = *ptr_wptr;\n size_t n = src.len;\n if (n > length) {\n n = length;\n }\n if (n > wend - wptr) {\n n = wend - wptr;\n }\n if (n > 0) {\n memmove(wptr, src.ptr, n);\n *ptr_wptr += n;\n }\n return n;\n}\n\nstatic inline puffs_base__empty_struct puffs_base__reader1__limit(\n puffs_base__reader1* r,\n uint64_t limit) {\n if (!r->use_limitt || (r->limitt > limit)) {\n r->limitt = limit;\n r->use_limitt = true;\n }\n return ((puffs_base__empty_struct){});\n}\n\nstatic inline puffs_base__empty_struct puffs_base__reader1__mark(\n puffs_base__reader1* r,\n uint8_t* mark) {\n r->private_impl.mark = mark;\n return ((puffs_base__empty_struct){});\n}\n\nstatic inline puffs_base__empty_struct puffs_base__writer1__limit(\n puffs_base__writer1* w,\n uint64_t limit) {\n if (!w->use_limitt || (w->limitt > limit)) {\n w->limitt = limit;\n w->use_limitt = true;\n }\n return ((puffs_base__empty_struct){});\n}\n\nstatic inline puffs_base__empty_stru" + - "ct puffs_base__writer1__mark(\n puffs_base__writer1* w,\n uint8_t* mark) {\n w->private_impl.mark = mark;\n return ((puffs_base__empty_struct){});\n}\n\n#endif // PUFFS_BASE_IMPL_H\n" + + " puffs_base__slice_u8 src,\n uint32_t length) {\n uint8_t* wptr = *ptr_wptr;\n size_t n = src.len;\n if (n > length) {\n n = length;\n }\n if (n > wend - wptr) {\n n = wend - wptr;\n }\n if (n > 0) {\n memmove(wptr, src.ptr, n);\n *ptr_wptr += n;\n }\n return n;\n}\n\n// Note that the *__limit and *__mark methods are private (in base-impl.h) not\n// public (in base-header.h). We assume that, at the boundary between user code\n// and Puffs code, the reader1 and writer1's private_impl fields (including\n// limit and mark) are NULL. Otherwise, some internal assumptions break down.\n// For example, the limit field is represented as a pointer, even though\n// conceptually it is a count, but that pointer-to-count correspondence becomes\n// invalid if a buffer is re-used (e.g. on resuming a coroutine).\n//\n// Admittedly, some of the Puffs test code calls these methods, but that test\n// code is still Puffs code, not user code. Other Puffs test code modifies\n// private_impl fields directly.\n\nstatic inline puffs_base__" + + "empty_struct puffs_base__reader1__limit(\n puffs_base__reader1* o,\n uint8_t* ptr,\n uint64_t limit) {\n if (!o->buf) {\n o->private_impl.limit = NULL;\n } else {\n uint64_t len = o->buf->wi - o->buf->ri;\n if (limit > len) {\n limit = len;\n }\n if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) {\n o->private_impl.limit = ptr + limit;\n }\n }\n return ((puffs_base__empty_struct){});\n}\n\nstatic inline puffs_base__empty_struct puffs_base__reader1__mark(\n puffs_base__reader1* o,\n uint8_t* mark) {\n o->private_impl.mark = mark;\n return ((puffs_base__empty_struct){});\n}\n\nstatic inline puffs_base__empty_struct puffs_base__writer1__limit(\n puffs_base__writer1* o,\n uint8_t* ptr,\n uint64_t limit) {\n if (!o->buf) {\n o->private_impl.limit = NULL;\n } else {\n uint64_t len = o->buf->len - o->buf->wi;\n if (limit > len) {\n limit = len;\n }\n if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) {\n o->private_impl.limit = " + + "ptr + limit;\n }\n }\n return ((puffs_base__empty_struct){});\n}\n\nstatic inline puffs_base__empty_struct puffs_base__writer1__mark(\n puffs_base__writer1* o,\n uint8_t* mark) {\n o->private_impl.mark = mark;\n return ((puffs_base__empty_struct){});\n}\n\n#endif // PUFFS_BASE_IMPL_H\n" + "" type template_args_short_read struct { @@ -42,7 +43,7 @@ type template_args_short_read struct { } func template_short_read(b *buffer, args template_args_short_read) error { - b.printf("short_read_%s:\nif (a_%s.buf && a_%s.buf->closed && !a_%s.use_limitt) {\nstatus = %sERROR_UNEXPECTED_EOF;\ngoto exit;\n}\nstatus = %sSUSPENSION_SHORT_READ;\ngoto suspend;\n", + b.printf("short_read_%s:\nif (a_%s.buf && a_%s.buf->closed && !a_%s.private_impl.limit) {\nstatus = %sERROR_UNEXPECTED_EOF;\ngoto exit;\n}\nstatus = %sSUSPENSION_SHORT_READ;\ngoto suspend;\n", args.name, args.name, args.name, diff --git a/cmd/puffs-c/internal/cgen/expr.go b/cmd/puffs-c/internal/cgen/expr.go index 79399477..f6d9d77f 100644 --- a/cmd/puffs-c/internal/cgen/expr.go +++ b/cmd/puffs-c/internal/cgen/expr.go @@ -169,12 +169,7 @@ func (g *gen) writeExprOther(b *buffer, n *a.Expr, rp replacementPolicy, pp pare return nil } if isInSrc(g.tm, n, t.KeyLimitt, 1) { - b.printf("puffs_base__reader1__limit(&%ssrc,", aPrefix) - if err := g.writeExpr(b, n.Args()[0].Arg().Value(), rp, parenthesesOptional, depth); err != nil { - return err - } - b.writes(")") - return nil + return fmt.Errorf("TODO: in.src.limit") } if isInSrc(g.tm, n, t.KeyMark, 0) { b.printf("puffs_base__reader1__mark(&%ssrc, %srptr_src)", aPrefix, bPrefix) @@ -188,12 +183,7 @@ func (g *gen) writeExprOther(b *buffer, n *a.Expr, rp replacementPolicy, pp pare return nil } if isInDst(g.tm, n, t.KeyLimitt, 1) { - b.printf("puffs_base__writer1__limit(&%sdst,", aPrefix) - if err := g.writeExpr(b, n.Args()[0].Arg().Value(), rp, parenthesesOptional, depth); err != nil { - return err - } - b.writes(")") - return nil + return fmt.Errorf("TODO: in.dst.limit") } if isInDst(g.tm, n, t.KeyMark, 0) { // TODO: is a private_impl.mark the right representation? What if @@ -314,8 +304,8 @@ func (g *gen) writeExprOther(b *buffer, n *a.Expr, rp replacementPolicy, pp pare return nil } if isThatMethod(g.tm, n, t.KeyLimitt, 1) { - // TODO: don't hard-code v_r. - b.printf("puffs_base__reader1__limit(&v_r,") + // TODO: don't hard-code v_r or b_rptr_src. + b.printf("puffs_base__reader1__limit(&v_r, b_rptr_src,") if err := g.writeExpr(b, n.Args()[0].Arg().Value(), rp, parenthesesOptional, depth); err != nil { return err } diff --git a/cmd/puffs-c/internal/cgen/templates.h b/cmd/puffs-c/internal/cgen/templates.h index c4fce55b..ae11fbb3 100644 --- a/cmd/puffs-c/internal/cgen/templates.h +++ b/cmd/puffs-c/internal/cgen/templates.h @@ -23,7 +23,7 @@ template short_read(string qPKGPREFIXq, string qnameq) { short_read_qnameq: - if (a_qnameq.buf && a_qnameq.buf->closed && !a_qnameq.use_limitt) { + if (a_qnameq.buf && a_qnameq.buf->closed && !a_qnameq.private_impl.limit) { status = qPKGPREFIXqERROR_UNEXPECTED_EOF; goto exit; } diff --git a/cmd/puffs-c/internal/cgen/var.go b/cmd/puffs-c/internal/cgen/var.go index 84b6e79b..965daf10 100644 --- a/cmd/puffs-c/internal/cgen/var.go +++ b/cmd/puffs-c/internal/cgen/var.go @@ -101,9 +101,10 @@ func (g *gen) writeLoadDerivedVar(b *buffer, name t.ID, typ *a.TypeExpr, header b.printf("%srptr_%s = %s%s.buf->ptr + %s%s.buf->ri;", bPrefix, nameStr, aPrefix, nameStr, aPrefix, nameStr) b.printf("uint64_t len = %s%s.buf->wi - %s%s.buf->ri;", aPrefix, nameStr, aPrefix, nameStr) - b.printf("if (%s%s.use_limitt && (len > %s%s.limitt)) { len = %s%s.limitt; }", - aPrefix, nameStr, aPrefix, nameStr, aPrefix, nameStr) b.printf("%srend_%s = %srptr_%s + len;", bPrefix, nameStr, bPrefix, nameStr) + b.printf("if (%s%s.private_impl.limit && (%srend_%s > %s%s.private_impl.limit)) {"+ + " %srend_%s = %s%s.private_impl.limit; }", + aPrefix, nameStr, bPrefix, nameStr, aPrefix, nameStr, bPrefix, nameStr, aPrefix, nameStr) b.printf("}\n") @@ -119,9 +120,10 @@ func (g *gen) writeLoadDerivedVar(b *buffer, name t.ID, typ *a.TypeExpr, header b.printf("%swend_%s = %swptr_%s;", bPrefix, nameStr, bPrefix, nameStr) b.printf("if (!%s%s.buf->closed) {", aPrefix, nameStr) b.printf("uint64_t len = %s%s.buf->len - %s%s.buf->wi;", aPrefix, nameStr, aPrefix, nameStr) - b.printf("if (%s%s.use_limitt && (len > %s%s.limitt)) { len = %s%s.limitt; }", - aPrefix, nameStr, aPrefix, nameStr, aPrefix, nameStr) b.printf("%swend_%s += len;", bPrefix, nameStr) + b.printf("if (%s%s.private_impl.limit && (%swend_%s > %s%s.private_impl.limit)) {"+ + " %swend_%s = %s%s.private_impl.limit; }", + aPrefix, nameStr, bPrefix, nameStr, aPrefix, nameStr, bPrefix, nameStr, aPrefix, nameStr) b.printf("}\n") b.printf("}\n") @@ -150,8 +152,6 @@ func (g *gen) writeSaveDerivedVar(b *buffer, name t.ID, typ *a.TypeExpr, footer b.printf("size_t n = %srptr_%s - (%s%s.buf->ptr + %s%s.buf->ri);", bPrefix, nameStr, aPrefix, nameStr, aPrefix, nameStr) b.printf("%s%s.buf->ri += n;", aPrefix, nameStr) - // TODO: Should limitt be a uint8_t*, not a uint64_t? - b.printf("if (%s%s.use_limitt) { %s%s.limitt -= n; }", aPrefix, nameStr, aPrefix, nameStr) if footer { b.printf("PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(%srend_%s);", bPrefix, nameStr) @@ -165,8 +165,6 @@ func (g *gen) writeSaveDerivedVar(b *buffer, name t.ID, typ *a.TypeExpr, footer b.printf("size_t n = %swptr_%s - (%s%s.buf->ptr + %s%s.buf->wi);", bPrefix, nameStr, aPrefix, nameStr, aPrefix, nameStr) b.printf("%s%s.buf->wi += n;", aPrefix, nameStr) - // TODO: Should limitt be a uint8_t*, not a uint64_t? - b.printf("if (%s%s.use_limitt) { %s%s.limitt -= n; }", aPrefix, nameStr, aPrefix, nameStr) if footer { b.printf("PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(%swend_%s);", bPrefix, nameStr) diff --git a/gen/c/std/flate.c b/gen/c/std/flate.c index d15dbdba..36ec7a6d 100644 --- a/gen/c/std/flate.c +++ b/gen/c/std/flate.c @@ -69,23 +69,27 @@ typedef struct { } puffs_base__buf1; 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } private_impl; } puffs_base__writer1; @@ -592,37 +596,65 @@ static inline uint32_t puffs_base__writer1__copy_from_slice32( 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, the limit field is represented as a pointer, even though +// conceptually it is a count, 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__empty_struct puffs_base__reader1__limit( - puffs_base__reader1* r, + puffs_base__reader1* o, + uint8_t* ptr, uint64_t limit) { - if (!r->use_limitt || (r->limitt > limit)) { - r->limitt = limit; - r->use_limitt = true; + if (!o->buf) { + o->private_impl.limit = NULL; + } else { + uint64_t len = o->buf->wi - o->buf->ri; + if (limit > len) { + limit = len; + } + if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) { + o->private_impl.limit = ptr + limit; + } } return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__reader1__mark( - puffs_base__reader1* r, + puffs_base__reader1* o, uint8_t* mark) { - r->private_impl.mark = mark; + o->private_impl.mark = mark; return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__writer1__limit( - puffs_base__writer1* w, + puffs_base__writer1* o, + uint8_t* ptr, uint64_t limit) { - if (!w->use_limitt || (w->limitt > limit)) { - w->limitt = limit; - w->use_limitt = true; + if (!o->buf) { + o->private_impl.limit = NULL; + } else { + uint64_t len = o->buf->len - o->buf->wi; + if (limit > len) { + limit = len; + } + if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) { + o->private_impl.limit = ptr + limit; + } } return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__writer1__mark( - puffs_base__writer1* w, + puffs_base__writer1* o, uint8_t* mark) { - w->private_impl.mark = mark; + o->private_impl.mark = mark; return ((puffs_base__empty_struct){}); } @@ -853,10 +885,10 @@ puffs_flate__status puffs_flate__flate_decoder__decode( b_wend_dst = b_wptr_dst; if (!a_dst.buf->closed) { uint64_t len = a_dst.buf->len - a_dst.buf->wi; - if (a_dst.use_limitt && (len > a_dst.limitt)) { - len = a_dst.limitt; - } b_wend_dst += len; + if (a_dst.private_impl.limit && (b_wend_dst > a_dst.private_impl.limit)) { + b_wend_dst = a_dst.private_impl.limit; + } } } @@ -876,9 +908,6 @@ puffs_flate__status puffs_flate__flate_decoder__decode( if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; - if (a_dst.use_limitt) { - a_dst.limitt -= n; - } } puffs_flate__status t_0 = puffs_flate__flate_decoder__decode_blocks(self, a_dst, a_src); @@ -887,10 +916,11 @@ puffs_flate__status puffs_flate__flate_decoder__decode( b_wend_dst = b_wptr_dst; if (!a_dst.buf->closed) { uint64_t len = a_dst.buf->len - a_dst.buf->wi; - if (a_dst.use_limitt && (len > a_dst.limitt)) { - len = a_dst.limitt; - } b_wend_dst += len; + if (a_dst.private_impl.limit && + (b_wend_dst > a_dst.private_impl.limit)) { + b_wend_dst = a_dst.private_impl.limit; + } } } v_z = t_0; @@ -956,9 +986,6 @@ exit: if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; - if (a_dst.use_limitt) { - a_dst.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_wend_dst); } @@ -980,10 +1007,10 @@ puffs_flate__status puffs_flate__flate_decoder__decode_blocks( if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = @@ -1017,19 +1044,17 @@ puffs_flate__status puffs_flate__flate_decoder__decode_blocks( if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } status = puffs_flate__flate_decoder__decode_uncompressed(self, a_dst, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && + (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } if (status) { goto suspend; @@ -1046,18 +1071,16 @@ puffs_flate__status puffs_flate__flate_decoder__decode_blocks( if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } status = puffs_flate__flate_decoder__init_dynamic_huffman(self, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && + (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } if (status) { goto suspend; @@ -1070,18 +1093,16 @@ puffs_flate__status puffs_flate__flate_decoder__decode_blocks( if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } status = puffs_flate__flate_decoder__decode_huffman(self, a_dst, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && + (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } if (status) { goto suspend; @@ -1104,16 +1125,13 @@ exit: if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_FLATE__ERROR_UNEXPECTED_EOF; goto exit; } @@ -1137,10 +1155,10 @@ puffs_flate__status puffs_flate__flate_decoder__decode_uncompressed( b_wend_dst = b_wptr_dst; if (!a_dst.buf->closed) { uint64_t len = a_dst.buf->len - a_dst.buf->wi; - if (a_dst.use_limitt && (len > a_dst.limitt)) { - len = a_dst.limitt; - } b_wend_dst += len; + if (a_dst.private_impl.limit && (b_wend_dst > a_dst.private_impl.limit)) { + b_wend_dst = a_dst.private_impl.limit; + } } } uint8_t* b_rptr_src = NULL; @@ -1148,10 +1166,10 @@ puffs_flate__status puffs_flate__flate_decoder__decode_uncompressed( if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = @@ -1236,24 +1254,18 @@ exit: if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; - if (a_dst.use_limitt) { - a_dst.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_wend_dst); } if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_FLATE__ERROR_UNEXPECTED_EOF; goto exit; } @@ -1288,10 +1300,10 @@ puffs_flate__status puffs_flate__flate_decoder__decode_huffman( b_wend_dst = b_wptr_dst; if (!a_dst.buf->closed) { uint64_t len = a_dst.buf->len - a_dst.buf->wi; - if (a_dst.use_limitt && (len > a_dst.limitt)) { - len = a_dst.limitt; - } b_wend_dst += len; + if (a_dst.private_impl.limit && (b_wend_dst > a_dst.private_impl.limit)) { + b_wend_dst = a_dst.private_impl.limit; + } } } uint8_t* b_rptr_src = NULL; @@ -1299,10 +1311,10 @@ puffs_flate__status puffs_flate__flate_decoder__decode_huffman( if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = @@ -1635,24 +1647,18 @@ exit: if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; - if (a_dst.use_limitt) { - a_dst.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_wend_dst); } if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_FLATE__ERROR_UNEXPECTED_EOF; goto exit; } @@ -1744,10 +1750,10 @@ puffs_flate__status puffs_flate__flate_decoder__init_dynamic_huffman( if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = @@ -1952,16 +1958,13 @@ exit: if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_FLATE__ERROR_UNEXPECTED_EOF; goto exit; } @@ -2275,10 +2278,10 @@ puffs_flate__status puffs_flate__zlib_decoder__decode( b_wend_dst = b_wptr_dst; if (!a_dst.buf->closed) { uint64_t len = a_dst.buf->len - a_dst.buf->wi; - if (a_dst.use_limitt && (len > a_dst.limitt)) { - len = a_dst.limitt; - } b_wend_dst += len; + if (a_dst.private_impl.limit && (b_wend_dst > a_dst.private_impl.limit)) { + b_wend_dst = a_dst.private_impl.limit; + } } } uint8_t* b_rptr_src = NULL; @@ -2286,10 +2289,10 @@ puffs_flate__status puffs_flate__zlib_decoder__decode( if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = self->private_impl.c_decode[0].coro_susp_point; @@ -2350,16 +2353,10 @@ puffs_flate__status puffs_flate__zlib_decoder__decode( if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; - if (a_dst.use_limitt) { - a_dst.limitt -= n; - } } if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } puffs_flate__status t_2 = puffs_flate__flate_decoder__decode( &self->private_impl.f_flate, a_dst, a_src); @@ -2368,19 +2365,21 @@ puffs_flate__status puffs_flate__zlib_decoder__decode( b_wend_dst = b_wptr_dst; if (!a_dst.buf->closed) { uint64_t len = a_dst.buf->len - a_dst.buf->wi; - if (a_dst.use_limitt && (len > a_dst.limitt)) { - len = a_dst.limitt; - } b_wend_dst += len; + if (a_dst.private_impl.limit && + (b_wend_dst > a_dst.private_impl.limit)) { + b_wend_dst = a_dst.private_impl.limit; + } } } if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && + (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } v_z = t_2; v_checksum = puffs_flate__adler32__update( @@ -2445,17 +2444,11 @@ exit: if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; - if (a_dst.use_limitt) { - a_dst.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_wend_dst); } if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } @@ -2463,7 +2456,7 @@ exit: return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_FLATE__ERROR_UNEXPECTED_EOF; goto exit; } diff --git a/gen/c/std/gif.c b/gen/c/std/gif.c index 23c4fc5c..5282b33b 100644 --- a/gen/c/std/gif.c +++ b/gen/c/std/gif.c @@ -69,23 +69,27 @@ typedef struct { } puffs_base__buf1; 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } private_impl; } puffs_base__writer1; @@ -539,37 +543,65 @@ static inline uint32_t puffs_base__writer1__copy_from_slice32( 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, the limit field is represented as a pointer, even though +// conceptually it is a count, 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__empty_struct puffs_base__reader1__limit( - puffs_base__reader1* r, + puffs_base__reader1* o, + uint8_t* ptr, uint64_t limit) { - if (!r->use_limitt || (r->limitt > limit)) { - r->limitt = limit; - r->use_limitt = true; + if (!o->buf) { + o->private_impl.limit = NULL; + } else { + uint64_t len = o->buf->wi - o->buf->ri; + if (limit > len) { + limit = len; + } + if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) { + o->private_impl.limit = ptr + limit; + } } return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__reader1__mark( - puffs_base__reader1* r, + puffs_base__reader1* o, uint8_t* mark) { - r->private_impl.mark = mark; + o->private_impl.mark = mark; return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__writer1__limit( - puffs_base__writer1* w, + puffs_base__writer1* o, + uint8_t* ptr, uint64_t limit) { - if (!w->use_limitt || (w->limitt > limit)) { - w->limitt = limit; - w->use_limitt = true; + if (!o->buf) { + o->private_impl.limit = NULL; + } else { + uint64_t len = o->buf->len - o->buf->wi; + if (limit > len) { + limit = len; + } + if (!o->private_impl.limit || (limit < (o->private_impl.limit - ptr))) { + o->private_impl.limit = ptr + limit; + } } return ((puffs_base__empty_struct){}); } static inline puffs_base__empty_struct puffs_base__writer1__mark( - puffs_base__writer1* w, + puffs_base__writer1* o, uint8_t* mark) { - w->private_impl.mark = mark; + o->private_impl.mark = mark; return ((puffs_base__empty_struct){}); } @@ -701,10 +733,10 @@ puffs_gif__status puffs_gif__decoder__decode(puffs_gif__decoder* self, if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = self->private_impl.c_decode[0].coro_susp_point; @@ -718,18 +750,15 @@ puffs_gif__status puffs_gif__decoder__decode(puffs_gif__decoder* self, if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } status = puffs_gif__decoder__decode_header(self, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } if (status) { goto suspend; @@ -738,18 +767,15 @@ puffs_gif__status puffs_gif__decoder__decode(puffs_gif__decoder* self, if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } status = puffs_gif__decoder__decode_lsd(self, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } if (status) { goto suspend; @@ -766,18 +792,16 @@ puffs_gif__status puffs_gif__decoder__decode(puffs_gif__decoder* self, if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } status = puffs_gif__decoder__decode_extension(self, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && + (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } if (status) { goto suspend; @@ -787,18 +811,16 @@ puffs_gif__status puffs_gif__decoder__decode(puffs_gif__decoder* self, if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } status = puffs_gif__decoder__decode_id(self, a_dst, a_src); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && + (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } if (status) { goto suspend; @@ -827,9 +849,6 @@ exit: if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } @@ -837,7 +856,7 @@ exit: return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_GIF__ERROR_UNEXPECTED_EOF; goto exit; } @@ -857,10 +876,10 @@ puffs_gif__status puffs_gif__decoder__decode_header(puffs_gif__decoder* self, if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = @@ -905,16 +924,13 @@ exit: if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_GIF__ERROR_UNEXPECTED_EOF; goto exit; } @@ -935,10 +951,10 @@ puffs_gif__status puffs_gif__decoder__decode_lsd(puffs_gif__decoder* self, if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = self->private_impl.c_decode_lsd[0].coro_susp_point; @@ -1009,16 +1025,13 @@ exit: if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_GIF__ERROR_UNEXPECTED_EOF; goto exit; } @@ -1039,10 +1052,10 @@ puffs_gif__status puffs_gif__decoder__decode_extension( if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = @@ -1109,16 +1122,13 @@ exit: if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_GIF__ERROR_UNEXPECTED_EOF; goto exit; } @@ -1144,10 +1154,10 @@ puffs_gif__status puffs_gif__decoder__decode_id(puffs_gif__decoder* self, if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = self->private_impl.c_decode_id[0].coro_susp_point; @@ -1206,24 +1216,22 @@ puffs_gif__status puffs_gif__decoder__decode_id(puffs_gif__decoder* self, while (true) { v_r = a_src; puffs_base__reader1__mark(&v_r, b_rptr_src); - puffs_base__reader1__limit(&v_r, v_block_size); + puffs_base__reader1__limit(&v_r, b_rptr_src, v_block_size); PUFFS_BASE__COROUTINE_SUSPENSION_POINT(4); if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } } puffs_gif__status t_3 = puffs_gif__lzw_decoder__decode( &self->private_impl.f_lzw, a_dst, v_r); if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && + (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } v_z = t_3; if (v_z == 0) { @@ -1278,16 +1286,13 @@ exit: if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_GIF__ERROR_UNEXPECTED_EOF; goto exit; } @@ -1348,10 +1353,10 @@ puffs_gif__status puffs_gif__lzw_decoder__decode(puffs_gif__lzw_decoder* self, b_wend_dst = b_wptr_dst; if (!a_dst.buf->closed) { uint64_t len = a_dst.buf->len - a_dst.buf->wi; - if (a_dst.use_limitt && (len > a_dst.limitt)) { - len = a_dst.limitt; - } b_wend_dst += len; + if (a_dst.private_impl.limit && (b_wend_dst > a_dst.private_impl.limit)) { + b_wend_dst = a_dst.private_impl.limit; + } } } uint8_t* b_rptr_src = NULL; @@ -1359,10 +1364,10 @@ puffs_gif__status puffs_gif__lzw_decoder__decode(puffs_gif__lzw_decoder* self, if (a_src.buf) { b_rptr_src = a_src.buf->ptr + a_src.buf->ri; uint64_t len = a_src.buf->wi - a_src.buf->ri; - if (a_src.use_limitt && (len > a_src.limitt)) { - len = a_src.limitt; - } b_rend_src = b_rptr_src + len; + if (a_src.private_impl.limit && (b_rend_src > a_src.private_impl.limit)) { + b_rend_src = a_src.private_impl.limit; + } } uint32_t coro_susp_point = self->private_impl.c_decode[0].coro_susp_point; @@ -1502,17 +1507,11 @@ exit: if (a_dst.buf) { size_t n = b_wptr_dst - (a_dst.buf->ptr + a_dst.buf->wi); a_dst.buf->wi += n; - if (a_dst.use_limitt) { - a_dst.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_wend_dst); } if (a_src.buf) { size_t n = b_rptr_src - (a_src.buf->ptr + a_src.buf->ri); a_src.buf->ri += n; - if (a_src.use_limitt) { - a_src.limitt -= n; - } PUFFS_BASE__IGNORE_POTENTIALLY_UNUSED_VARIABLE(b_rend_src); } @@ -1520,7 +1519,7 @@ exit: return status; short_read_src: - if (a_src.buf && a_src.buf->closed && !a_src.use_limitt) { + if (a_src.buf && a_src.buf->closed && !a_src.private_impl.limit) { status = PUFFS_GIF__ERROR_UNEXPECTED_EOF; goto exit; } diff --git a/gen/h/std/flate.h b/gen/h/std/flate.h index 8a073495..09b717cb 100644 --- a/gen/h/std/flate.h +++ b/gen/h/std/flate.h @@ -69,23 +69,27 @@ typedef struct { } puffs_base__buf1; 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } private_impl; } puffs_base__writer1; diff --git a/gen/h/std/gif.h b/gen/h/std/gif.h index 0c6eef17..c9dfcfcf 100644 --- a/gen/h/std/gif.h +++ b/gen/h/std/gif.h @@ -69,23 +69,27 @@ typedef struct { } puffs_base__buf1; 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } 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; - uint64_t limitt; // TODO: should this be uint8_t*, not (uint64_t + bool)? - bool use_limitt; // Do not access the private_impl's fields directly. There is no API/ABI // compatibility or safety guarantee if you do so. struct { + uint8_t* limit; uint8_t* mark; } private_impl; } puffs_base__writer1; diff --git a/test/c/std/flate.c b/test/c/std/flate.c index 378ef46f..fcadde80 100644 --- a/test/c/std/flate.c +++ b/test/c/std/flate.c @@ -189,14 +189,14 @@ const char* puffs_flate_decode(puffs_base__buf1* dst, uint64_t rlimit) { puffs_flate__flate_decoder dec; puffs_flate__flate_decoder__initialize(&dec, PUFFS_VERSION, 0); - puffs_base__writer1 dst_writer = {.buf = dst}; - puffs_base__reader1 src_reader = {.buf = src}; while (true) { + puffs_base__writer1 dst_writer = {.buf = dst}; if (wlimit) { - puffs_base__writer1__limit(&dst_writer, wlimit); + puffs_base__writer1__limit(&dst_writer, dst->ptr + dst->wi, wlimit); } + puffs_base__reader1 src_reader = {.buf = src}; if (rlimit) { - puffs_base__reader1__limit(&src_reader, rlimit); + puffs_base__reader1__limit(&src_reader, src->ptr + src->ri, rlimit); } puffs_flate__status s = @@ -219,15 +219,15 @@ const char* puffs_zlib_decode(puffs_base__buf1* dst, uint64_t rlimit) { puffs_flate__zlib_decoder dec; puffs_flate__zlib_decoder__initialize(&dec, PUFFS_VERSION, 0); - puffs_base__writer1 dst_writer = {.buf = dst}; - puffs_base__reader1 src_reader = {.buf = src}; while (true) { + puffs_base__writer1 dst_writer = {.buf = dst}; if (wlimit) { - puffs_base__writer1__limit(&dst_writer, wlimit); + puffs_base__writer1__limit(&dst_writer, dst->ptr + dst->wi, wlimit); } + puffs_base__reader1 src_reader = {.buf = src}; if (rlimit) { - puffs_base__reader1__limit(&src_reader, rlimit); + puffs_base__reader1__limit(&src_reader, src->ptr + src->ri, rlimit); } puffs_flate__status s = @@ -373,7 +373,7 @@ bool do_test_puffs_flate_history(int i, dec->private_impl.f_history_index = starting_history_index; - puffs_base__writer1__limit(&dst_writer, limit); + puffs_base__writer1__limit(&dst_writer, got->ptr + got->wi, limit); puffs_flate__status got_s = puffs_flate__flate_decoder__decode(dec, dst_writer, src_reader); diff --git a/test/c/std/gif.c b/test/c/std/gif.c index 9783bbc1..6f886385 100644 --- a/test/c/std/gif.c +++ b/test/c/std/gif.c @@ -229,16 +229,16 @@ bool do_test_puffs_gif_lzw_decode(const char* src_filename, puffs_gif__lzw_decoder dec; puffs_gif__lzw_decoder__initialize(&dec, PUFFS_VERSION, 0); puffs_gif__lzw_decoder__set_literal_width(&dec, literal_width); - puffs_base__writer1 got_writer = {.buf = &got}; - puffs_base__reader1 src_reader = {.buf = &src}; int num_iters = 0; while (true) { num_iters++; + puffs_base__writer1 got_writer = {.buf = &got}; if (wlimit) { - puffs_base__writer1__limit(&got_writer, wlimit); + puffs_base__writer1__limit(&got_writer, got.ptr + got.wi, wlimit); } + puffs_base__reader1 src_reader = {.buf = &src}; if (rlimit) { - puffs_base__reader1__limit(&src_reader, rlimit); + puffs_base__reader1__limit(&src_reader, src.ptr + src.ri, rlimit); } size_t old_wi = got.wi; size_t old_ri = src.ri; @@ -408,16 +408,16 @@ bool do_test_puffs_gif_decode(const char* filename, puffs_gif__decoder dec; puffs_gif__decoder__initialize(&dec, PUFFS_VERSION, 0); - puffs_base__writer1 got_writer = {.buf = &got}; - puffs_base__reader1 src_reader = {.buf = &src}; int num_iters = 0; while (true) { num_iters++; + puffs_base__writer1 got_writer = {.buf = &got}; if (wlimit) { - puffs_base__writer1__limit(&got_writer, wlimit); + puffs_base__writer1__limit(&got_writer, got.ptr + got.wi, wlimit); } + puffs_base__reader1 src_reader = {.buf = &src}; if (rlimit) { - puffs_base__reader1__limit(&src_reader, rlimit); + puffs_base__reader1__limit(&src_reader, src.ptr + src.ri, rlimit); } size_t old_wi = got.wi; size_t old_ri = src.ri; @@ -727,9 +727,8 @@ proc tests[] = { // GIF Tests test_puffs_gif_decode_input_is_a_gif, // - // TODO: uncomment. - // test_puffs_gif_decode_input_is_a_gif_many_big_reads, // - // test_puffs_gif_decode_input_is_a_gif_many_medium_reads, // + test_puffs_gif_decode_input_is_a_gif_many_big_reads, // + test_puffs_gif_decode_input_is_a_gif_many_medium_reads, // test_puffs_gif_decode_input_is_a_gif_many_small_writes_reads, // test_puffs_gif_decode_input_is_a_png, //