From 3b57548b0dd3a8634ae0bfa67330b27298779f97 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Fri, 29 Sep 2017 17:07:41 +1000 Subject: [PATCH] Generate C code for a non-trivial slice-of-slice. --- cmd/puffs-c/internal/cgen/base-impl.h | 34 +++++++++++++ cmd/puffs-c/internal/cgen/data.go | 5 +- cmd/puffs-c/internal/cgen/expr.go | 46 +++++++++++++++--- gen/c/std/flate.c | 41 ++++++++++++++++ gen/c/std/gif.c | 34 +++++++++++++ lang/check/assert.go | 21 +++++++- lang/check/bounds.go | 69 +++++++++++++-------------- lang/token/list.go | 10 ++++ std/flate/decode_flate.puffs | 5 ++ 9 files changed, 221 insertions(+), 44 deletions(-) diff --git a/cmd/puffs-c/internal/cgen/base-impl.h b/cmd/puffs-c/internal/cgen/base-impl.h index 3a6bd501..8f524a5f 100644 --- a/cmd/puffs-c/internal/cgen/base-impl.h +++ b/cmd/puffs-c/internal/cgen/base-impl.h @@ -93,6 +93,40 @@ static inline puffs_base_slice_u8 puffs_base_make_slice_u8_from_ptrs( return ((puffs_base_slice_u8){}); } +static inline puffs_base_slice_u8 puffs_base_make_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_make_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_make_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 n bytes of s. static inline puffs_base_slice_u8 puffs_base_slice_u8_prefix( puffs_base_slice_u8 s, diff --git a/cmd/puffs-c/internal/cgen/data.go b/cmd/puffs-c/internal/cgen/data.go index 84eb65b5..aa66903f 100644 --- a/cmd/puffs-c/internal/cgen/data.go +++ b/cmd/puffs-c/internal/cgen/data.go @@ -15,8 +15,9 @@ const baseImpl = "" + "#ifndef PUFFS_BASE_IMPL_H\n#define PUFFS_BASE_IMPL_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#define PUFFS_IGNORE_POTENTIALLY_UNUSED_VARIABLE(x) (void)(x)\n\n// Use switch cases for coroutine suspension points, similar to the technique\n// in https://www.chiark.greenend.org.uk/~sgtatham/coroutines.html\n//\n// We use a trivial macro instead of an explicit assignment and case statement\n// so that clang-format doesn't get confused by the unusual \"case\"s.\n#define PUFFS_COROUTINE_SUSPENSION_POINT(n) \\\n coro_susp_point = n; \\\n case n:\n\n// Clang also defines \"__GNUC__\".\n#if defined(__GNUC__)\n#define PUFFS_LIKELY(expr) (__builtin_expect(!!(expr), 1))\n#define PUFFS_UNLIKELY(expr) (__builtin_expect(!!(expr), 0))\n// Declare the printf prototype. The generated code shouldn't need this at all,\n// but it's useful for manual printf debugging.\nextern int printf(const char* __restrict __format, ...);\n#else\n#define PUFFS_LIKELY(expr) (expr)\n#de" + "fine PUFFS_UNLIKELY(expr) (expr)\n#endif\n\n// ---------------- Static Inline Functions\n//\n// The helpers below are functions, instead of macros, because their arguments\n// can be an expression that we shouldn't evaluate more than once.\n//\n// They are in base-impl.h and hence copy/pasted into every generated C file,\n// instead of being in some \"base.c\" file, since a design goal is that users of\n// the generated C code can often just #include a single .c file, such as\n// \"gif.c\", without having to additionally include or otherwise build and link\n// a \"base.c\" file.\n//\n// They are static, so that linking multiple puffs .o files won't complain about\n// duplicate function definitions.\n//\n// They are explicitly marked inline, even if modern compilers don't use the\n// inline attribute to guide optimizations such as inlining, to avoid the\n// -Wunused-function warning, and we like to compile with -Wall -Werror.\n\nstatic inline uint16_t puffs_base_load_u16be(uint8_t* p) {\n return ((uint16_t)(p[0]) << 8) | ((uint16_t)(p[1" + "]) << 0);\n}\n\nstatic inline uint16_t puffs_base_load_u16le(uint8_t* p) {\n return ((uint16_t)(p[0]) << 0) | ((uint16_t)(p[1]) << 8);\n}\n\nstatic inline uint32_t puffs_base_load_u32be(uint8_t* p) {\n return ((uint32_t)(p[0]) << 24) | ((uint32_t)(p[1]) << 16) |\n ((uint32_t)(p[2]) << 8) | ((uint32_t)(p[3]) << 0);\n}\n\nstatic inline uint32_t puffs_base_load_u32le(uint8_t* p) {\n return ((uint32_t)(p[0]) << 0) | ((uint32_t)(p[1]) << 8) |\n ((uint32_t)(p[2]) << 16) | ((uint32_t)(p[3]) << 24);\n}\n\nstatic inline puffs_base_slice_u8 puffs_base_make_slice_u8_from_ints(\n uint8_t* start,\n uint64_t i,\n uint64_t j,\n uint64_t k) {\n if ((i <= j) && (j <= k) && (k <= SIZE_MAX)) {\n return ((puffs_base_slice_u8){\n .ptr = start + i,\n .len = j - i,\n });\n }\n return ((puffs_base_slice_u8){});\n}\n\nstatic inline puffs_base_slice_u8 puffs_base_make_slice_u8_from_ptrs(\n uint8_t* start,\n uint8_t* mark0,\n uint8_t* mark1,\n uint8_t* end) {\n if ((start <= mark0) && (mark0 <= mark1) && " + - "(mark1 <= end)) {\n return ((puffs_base_slice_u8){\n .ptr = mark0,\n .len = mark1 - mark0,\n });\n }\n return ((puffs_base_slice_u8){});\n}\n\n// puffs_base_slice_u8_prefix returns up to the first n bytes of s.\nstatic inline puffs_base_slice_u8 puffs_base_slice_u8_prefix(\n puffs_base_slice_u8 s,\n uint64_t n) {\n if ((uint64_t)(s.len) > n) {\n s.len = n;\n }\n return s;\n}\n\n// puffs_base_slice_u8_suffix returns up to the last n bytes of s.\nstatic inline puffs_base_slice_u8 puffs_base_slice_u8_suffix(\n puffs_base_slice_u8 s,\n uint64_t n) {\n if ((uint64_t)(s.len) > n) {\n s.ptr += (uint64_t)(s.len) - n;\n s.len = n;\n }\n return s;\n}\n\n// puffs_base_slice_u8_copy_from calls memmove(dst.ptr, src.ptr, n) where n is\n// the minimum of dst.len and src.len.\n//\n// Passing a puffs_base_slice_u8 with all fields NULL or zero (a valid, empty\n// slice) is valid and results in a no-op.\nstatic inline uint64_t puffs_base_slice_u8_copy_from(puffs_base_slice_u8 dst,\n " + - " puffs_base_slice_u8 src) {\n size_t n = dst.len < src.len ? dst.len : src.len;\n if (n > 0) {\n memmove(dst.ptr, src.ptr, n);\n }\n return n;\n}\n\n#endif // PUFFS_BASE_IMPL_H\n" + + "(mark1 <= end)) {\n return ((puffs_base_slice_u8){\n .ptr = mark0,\n .len = mark1 - mark0,\n });\n }\n return ((puffs_base_slice_u8){});\n}\n\nstatic inline puffs_base_slice_u8 puffs_base_make_slice_u8_subslice_i(\n puffs_base_slice_u8 s,\n uint64_t i) {\n if ((i <= SIZE_MAX) && (i <= s.len)) {\n return ((puffs_base_slice_u8){\n .ptr = s.ptr + i,\n .len = s.len - i,\n });\n }\n return ((puffs_base_slice_u8){});\n}\n\nstatic inline puffs_base_slice_u8 puffs_base_make_slice_u8_subslice_j(\n puffs_base_slice_u8 s,\n uint64_t j) {\n if ((j <= SIZE_MAX) && (j <= s.len)) {\n return ((puffs_base_slice_u8){.ptr = s.ptr, .len = j});\n }\n return ((puffs_base_slice_u8){});\n}\n\nstatic inline puffs_base_slice_u8 puffs_base_make_slice_u8_subslice_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 n bytes of s.\nstatic inline puffs_base_slice_u8 puffs_base_slice_u8_prefix(\n puffs_base_slice_u8 s,\n uint64_t n) {\n if ((uint64_t)(s.len) > n) {\n s.len = n;\n }\n return s;\n}\n\n// puffs_base_slice_u8_suffix returns up to the last n bytes of s.\nstatic inline puffs_base_slice_u8 puffs_base_slice_u8_suffix(\n puffs_base_slice_u8 s,\n uint64_t n) {\n if ((uint64_t)(s.len) > n) {\n s.ptr += (uint64_t)(s.len) - n;\n s.len = n;\n }\n return s;\n}\n\n// puffs_base_slice_u8_copy_from calls memmove(dst.ptr, src.ptr, n) where n is\n// the minimum of dst.len and src.len.\n//\n// Passing a puffs_base_slice_u8 with all fields NULL or zero (a valid, empty\n// slice) is valid and results in a no-op.\nstatic inline uint64_t puffs_base_slice_u8_copy_from(puffs_base_slice_u8 dst,\n puffs_base_slice_u8 src) {\n size_t n = dst.len < src.len ? dst.len : src.len;\n if (n > 0) {\n memmove(dst.ptr, src.ptr, n);\n " + + " }\n return n;\n}\n\n#endif // PUFFS_BASE_IMPL_H\n" + "" type template_args_short_read struct { diff --git a/cmd/puffs-c/internal/cgen/expr.go b/cmd/puffs-c/internal/cgen/expr.go index dfe0f998..240f8f38 100644 --- a/cmd/puffs-c/internal/cgen/expr.go +++ b/cmd/puffs-c/internal/cgen/expr.go @@ -249,14 +249,48 @@ func (g *gen) writeExprOther(b *buffer, n *a.Expr, rp replacementPolicy, pp pare } b.writeb(',') b.writes(length) - b.writes(")") + b.writeb(')') } else { // Slice of a slice. - if mhs != nil || rhs != nil { - return fmt.Errorf("TODO: writeExprOther for a non-trivial slice of a slice") - } - if err := g.writeExpr(b, lhs, rp, parenthesesMandatory, depth); err != nil { - return err + switch { + case mhs == nil && rhs == nil: + if err := g.writeExpr(b, lhs, rp, parenthesesMandatory, depth); err != nil { + return err + } + case mhs != nil && rhs == nil: + b.writes("puffs_base_make_slice_u8_subslice_i(") + if err := g.writeExpr(b, lhs, rp, parenthesesOptional, depth); err != nil { + return err + } + b.writeb(',') + if err := g.writeExpr(b, mhs, rp, parenthesesOptional, depth); err != nil { + return err + } + b.writeb(')') + case mhs == nil && rhs != nil: + b.writes("puffs_base_make_slice_u8_subslice_j(") + if err := g.writeExpr(b, lhs, rp, parenthesesOptional, depth); err != nil { + return err + } + b.writeb(',') + if err := g.writeExpr(b, rhs, rp, parenthesesOptional, depth); err != nil { + return err + } + b.writeb(')') + case mhs != nil && rhs != nil: + b.writes("puffs_base_make_slice_u8_subslice_ij(") + if err := g.writeExpr(b, lhs, rp, parenthesesOptional, depth); err != nil { + return err + } + b.writeb(',') + if err := g.writeExpr(b, mhs, rp, parenthesesOptional, depth); err != nil { + return err + } + b.writeb(',') + if err := g.writeExpr(b, rhs, rp, parenthesesOptional, depth); err != nil { + return err + } + b.writeb(')') } } return nil diff --git a/gen/c/std/flate.c b/gen/c/std/flate.c index 80187d7f..7bcf0df5 100644 --- a/gen/c/std/flate.c +++ b/gen/c/std/flate.c @@ -385,6 +385,40 @@ static inline puffs_base_slice_u8 puffs_base_make_slice_u8_from_ptrs( return ((puffs_base_slice_u8){}); } +static inline puffs_base_slice_u8 puffs_base_make_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_make_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_make_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 n bytes of s. static inline puffs_base_slice_u8 puffs_base_slice_u8_prefix( puffs_base_slice_u8 s, @@ -706,6 +740,13 @@ puffs_flate_status puffs_flate_decoder_decode(puffs_flate_decoder* self, self->private_impl.f_history, self->private_impl.f_history_index & 32767, 32768, 32768), v_written); + if (v_n < ((uint64_t)(v_written.len))) { + v_written = puffs_base_make_slice_u8_subslice_i(v_written, v_n); + v_n = puffs_base_slice_u8_copy_from( + puffs_base_make_slice_u8_from_ints(self->private_impl.f_history, + 0, 32768, 32768), + v_written); + } } } status = v_z; diff --git a/gen/c/std/gif.c b/gen/c/std/gif.c index a1a70919..8a5bc440 100644 --- a/gen/c/std/gif.c +++ b/gen/c/std/gif.c @@ -356,6 +356,40 @@ static inline puffs_base_slice_u8 puffs_base_make_slice_u8_from_ptrs( return ((puffs_base_slice_u8){}); } +static inline puffs_base_slice_u8 puffs_base_make_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_make_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_make_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 n bytes of s. static inline puffs_base_slice_u8 puffs_base_slice_u8_prefix( puffs_base_slice_u8 s, diff --git a/lang/check/assert.go b/lang/check/assert.go index 04a7d022..26d7a2b5 100644 --- a/lang/check/assert.go +++ b/lang/check/assert.go @@ -283,7 +283,7 @@ func (q *checker) proveBinaryOp(op t.Key, lhs *a.Expr, rhs *a.Expr) error { continue } factOp := x.ID0().Key() - if factOp == op && x.RHS().Expr().Eq(rhs) { + if opImpliesOp(factOp, op) && x.RHS().Expr().Eq(rhs) { return nil } @@ -309,6 +309,21 @@ func (q *checker) proveBinaryOp(op t.Key, lhs *a.Expr, rhs *a.Expr) error { return errFailed } +// opImpliesOp returns whether the first op implies the second. For example, +// knowing "x < y" implies that "x != y" and "x <= y". +func opImpliesOp(op0 t.Key, op1 t.Key) bool { + if op0 == op1 { + return true + } + switch op0 { + case t.KeyXBinaryLessThan: + return op1 == t.KeyXBinaryNotEq || op1 == t.KeyXBinaryLessEq + case t.KeyXBinaryGreaterThan: + return op1 == t.KeyXBinaryNotEq || op1 == t.KeyXBinaryGreaterEq + } + return false +} + func errFailedOrNil(ok bool) error { if ok { return nil @@ -319,6 +334,10 @@ func errFailedOrNil(ok bool) error { var errFailed = errors.New("failed") func proveReasonRequirement(q *checker, op t.ID, lhs *a.Expr, rhs *a.Expr) error { + if !op.IsXBinaryOp() { + return fmt.Errorf( + "check: internal error: proveReasonRequirement token.Key (0x%02X) is not an XBinaryOp", op.Key()) + } if err := q.proveBinaryOp(op.Key(), lhs, rhs); err != nil { n := a.NewExpr(a.FlagsTypeChecked, op, 0, lhs.Node(), nil, rhs.Node(), nil) return fmt.Errorf("cannot prove %q: %v", n.String(q.tm), err) diff --git a/lang/check/bounds.go b/lang/check/bounds.go index 51cf7c0f..eac6eaf1 100644 --- a/lang/check/bounds.go +++ b/lang/check/bounds.go @@ -766,52 +766,51 @@ func (q *checker) bcheckExprOther(n *a.Expr, depth uint32) (*big.Int, *big.Int, } case t.KeyColon: + lhs := n.LHS().Expr() mhs := n.MHS().Expr() rhs := n.RHS().Expr() if mhs == nil && rhs == nil { return nil, nil, nil } - lTyp := n.LHS().Expr().MType() - mMin, mMax := (*big.Int)(nil), (*big.Int)(nil) - if mhs != nil { - var err error - mMin, mMax, err = q.bcheckExpr(mhs, depth) - if err != nil { - return nil, nil, err - } - } - rMin, rMax := (*big.Int)(nil), (*big.Int)(nil) - if rhs != nil { - var err error - rMin, rMax, err = q.bcheckExpr(rhs, depth) - if err != nil { - return nil, nil, err - } - } - - if lTyp.Decorator().Key() == t.KeyOpenBracket { + lengthExpr := (*a.Expr)(nil) + if lTyp := lhs.MType(); lTyp.Decorator().Key() == t.KeyOpenBracket { // Slice of an array. cv := lTyp.ArrayLength().ConstValue() - if mhs != nil && (mMin.Cmp(zero) < 0 || mMax.Cmp(cv) > 0) { - return nil, nil, fmt.Errorf("check: slice index %q (of range %v..%v) out of range", - mhs.String(q.tm), mMin, mMax) + id, err := q.tm.Insert(cv.String()) + if err != nil { + return nil, nil, err } - if rhs != nil && (rMin.Cmp(zero) < 0 || rMax.Cmp(cv) > 0) { - return nil, nil, fmt.Errorf("check: slice index %q (of range %v..%v) out of range", - rhs.String(q.tm), rMin, rMax) - } - if mhs != nil && rhs != nil && mMax.Cmp(rMin) > 0 { - return nil, nil, fmt.Errorf("check: slice indexes "+ - "%q (of range %v..%v) and %q (of range %v..%v) overlap", - mhs.String(q.tm), mMin, mMax, - rhs.String(q.tm), rMin, rMax, - ) - } - + lengthExpr = a.NewExpr(a.FlagsTypeChecked, 0, id, nil, nil, nil, nil) + lengthExpr.SetConstValue(cv) + lengthExpr.SetMType(typeExprIdeal) } else { // Slice of a slice. - return nil, nil, fmt.Errorf("TODO: bcheckExprOther for a non-trivial slice of a slice") + lengthExpr = a.NewExpr(a.FlagsTypeChecked, t.IDDot, t.IDLength, lhs.Node(), nil, nil, nil) + lengthExpr.SetMType(typeExprPlaceholder) // HACK. + lengthExpr = a.NewExpr(a.FlagsTypeChecked, t.IDOpenParen, 0, lengthExpr.Node(), nil, nil, nil) + lengthExpr.SetMType(typeExprU64) + } + + if mhs == nil { + mhs = zeroExpr + } + if rhs == nil { + rhs = lengthExpr + } + + if mhs != zeroExpr { + if err := proveReasonRequirement(q, t.IDXBinaryLessEq, zeroExpr, mhs); err != nil { + return nil, nil, err + } + } + if err := proveReasonRequirement(q, t.IDXBinaryLessEq, mhs, rhs); err != nil { + return nil, nil, err + } + if rhs != lengthExpr { + if err := proveReasonRequirement(q, t.IDXBinaryLessEq, rhs, lengthExpr); err != nil { + return nil, nil, err + } } return nil, nil, nil diff --git a/lang/token/list.go b/lang/token/list.go index 7311f8eb..38eee462 100644 --- a/lang/token/list.go +++ b/lang/token/list.go @@ -39,6 +39,8 @@ const ( // Key is the high 16 bits of an ID. It is the map key for a Map. type Key uint32 +func (k Key) isXOp() bool { return minXKey <= k && k <= maxXKey } + const ( FlagsBits = 16 FlagsMask = 1<