diff --git a/README.md b/README.md index 4d10739f..e5bb39a7 100644 --- a/README.md +++ b/README.md @@ -288,7 +288,7 @@ be enclosed by curly `{}`s. There is no 'dangling else' ambiguity. ## Keywords -Puffs is a simple language, with only 21 keywords. 5 of these introduce +Puffs is a simple language, with only 22 keywords. 5 of these introduce top-level concepts: - `error` @@ -328,6 +328,10 @@ top-level concepts: - `var` +1 keyword deals with I/O: + +- `limit` + ## Operators diff --git a/cmd/puffs-gen-c/base-header.h b/cmd/puffs-gen-c/base-header.h index cb68bdf5..e6183ae6 100644 --- a/cmd/puffs-gen-c/base-header.h +++ b/cmd/puffs-gen-c/base-header.h @@ -46,14 +46,19 @@ 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; + typedef struct { puffs_base_buf1* buf; - // TODO: limits. + puffs_base_limit limit; } puffs_base_reader1; typedef struct { puffs_base_buf1* buf; - // TODO: limits. + puffs_base_limit 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 e8b6b595..2daf4287 100644 --- a/cmd/puffs-gen-c/data.go +++ b/cmd/puffs-gen-c/data.go @@ -7,7 +7,7 @@ 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 {\n puffs_base_buf1* buf;\n // TODO: limits.\n} puffs_base_reader1;\n\ntypedef struct {\n puffs_base_buf1* buf;\n // TODO: limits.\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\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" + "" const baseImpl = "" + diff --git a/cmd/puffs-gen-c/main.go b/cmd/puffs-gen-c/main.go index d5bb5f47..c10ffa3c 100644 --- a/cmd/puffs-gen-c/main.go +++ b/cmd/puffs-gen-c/main.go @@ -35,6 +35,7 @@ var ( const ( aPrefix = "a_" // Function argument. fPrefix = "f_" // Struct field. + lPrefix = "l_" // Limit length. tPrefix = "t_" // Temporary local variable. vPrefix = "v_" // Local variable. ) @@ -125,12 +126,13 @@ type status struct { } type perFunc struct { - funk *a.Func - jumpTargets map[*a.While]uint32 - tempW uint32 - tempR uint32 - public bool - suspendible bool + funk *a.Func + jumpTargets map[*a.While]uint32 + tempW uint32 + tempR uint32 + public bool + suspendible bool + limitVarName string } type gen struct { @@ -721,6 +723,9 @@ func (g *gen) writeVars(block []*a.Node, depth uint32) error { case a.KVar: o := o.Var() + if v := o.Value(); v != nil && v.ID0().Key() == t.KeyLimit { + g.printf("uint64_t %s%v;\n", lPrefix, o.Name().String(g.tm)) + } if err := g.writeCTypeName(o.XType(), vPrefix, o.Name().String(g.tm)); err != nil { return err } @@ -873,6 +878,15 @@ func (g *gen) writeStatement(n *a.Node, depth uint32) error { if err := g.writeSuspendibles(v, depth); err != nil { return err } + if v.ID0().Key() == t.KeyLimit { + g.perFunc.limitVarName = n.Name().String(g.tm) + g.printf("%s%s =", lPrefix, g.perFunc.limitVarName) + if err := g.writeExpr( + v.LHS().Expr(), replaceCallSuspendibles, parenthesesMandatory, depth); err != nil { + return err + } + g.writes(";\n") + } } if n.XType().Decorator().Key() == t.KeyOpenBracket { if n.Value() != nil { @@ -1084,6 +1098,12 @@ func (g *gen) writeCallSuspendibles(n *a.Expr, depth uint32) error { g.pkgName, g.perFunc.funk.Receiver().String(g.tm), aPrefix, aPrefix) g.writes("if (status) { goto cleanup0; }\n") + } else if isDecode(g.tm, n) { + g.printf("status = puffs_%s_lzw_decoder_decode(&self->private_impl.f_lzw, %sdst, %s%s);\n", + g.pkgName, aPrefix, vPrefix, n.Args()[1].Arg().Value().String(g.tm)) + g.writes("if (status) { return status; }\n") + return nil + } else { // TODO: fix this. // @@ -1212,6 +1232,17 @@ func (g *gen) writeExprOther(n *a.Expr, rp replacementPolicy, depth uint32) erro g.writes(fPrefix) g.writes(n.ID1().String(g.tm)) return nil + + case t.KeyLimit: + // 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(".next = &a_src.limit,") + g.writes("}}") + g.perFunc.limitVarName = "" + return nil } return fmt.Errorf("unrecognized token.Key (0x%X) for writeExprOther", n.ID0().Key()) } @@ -1280,6 +1311,15 @@ func isSetLiteralWidth(tm *t.Map, n *a.Expr) bool { return n.ID0().Key() == t.KeyDot && n.ID1() == tm.ByName("set_literal_width") } +func isDecode(tm *t.Map, n *a.Expr) bool { + // TODO: check that n.Args() is "(dst:bar, src:baz)". + if n.ID0().Key() != t.KeyOpenParen || !n.CallSuspendible() || len(n.Args()) != 2 { + return false + } + n = n.LHS().Expr() + return n.ID0().Key() == t.KeyDot && n.ID1() == tm.ByName("decode") +} + func (g *gen) writeExprUnaryOp(n *a.Expr, rp replacementPolicy, depth uint32) error { // TODO. return nil diff --git a/gen/c/std/gif.c b/gen/c/std/gif.c index 7122c5f4..5522f58d 100644 --- a/gen/c/std/gif.c +++ b/gen/c/std/gif.c @@ -49,14 +49,19 @@ 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; + typedef struct { puffs_base_buf1* buf; - // TODO: limits. + puffs_base_limit limit; } puffs_base_reader1; typedef struct { puffs_base_buf1* buf; - // TODO: limits. + puffs_base_limit limit; } puffs_base_writer1; #endif // PUFFS_BASE_HEADER_H @@ -508,6 +513,8 @@ puffs_gif_status puffs_gif_decoder_decode_id(puffs_gif_decoder* self, bool v_interlace; uint8_t v_lw; uint8_t v_block_size; + uint64_t l_lzw_src; + puffs_base_reader1 v_lzw_src; for (size_t i = 0; i < 9; i++) { v_c[i] = 0; @@ -552,15 +559,17 @@ puffs_gif_status puffs_gif_decoder_decode_id(puffs_gif_decoder* self, if (v_block_size == 0) { goto label_0_break; } - size_t t_3 = ((uint32_t)(v_block_size)); - if (t_3 > a_src.buf->wi - a_src.buf->ri) { - t_3 -= a_src.buf->wi - a_src.buf->ri; - a_src.buf->ri = a_src.buf->wi; - status = a_src.buf->closed ? puffs_gif_error_unexpected_eof - : puffs_gif_status_short_read; + 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, + }}; + status = puffs_gif_lzw_decoder_decode(&self->private_impl.f_lzw, a_dst, + v_lzw_src); + if (status) { return status; } - a_src.buf->ri += t_3; } label_0_break:; diff --git a/gen/h/std/gif.h b/gen/h/std/gif.h index a10ca90d..84c586a9 100644 --- a/gen/h/std/gif.h +++ b/gen/h/std/gif.h @@ -49,14 +49,19 @@ 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; + typedef struct { puffs_base_buf1* buf; - // TODO: limits. + puffs_base_limit limit; } puffs_base_reader1; typedef struct { puffs_base_buf1* buf; - // TODO: limits. + puffs_base_limit limit; } puffs_base_writer1; #endif // PUFFS_BASE_HEADER_H diff --git a/lang/ast/ast.go b/lang/ast/ast.go index 206d7e0f..88c8be08 100644 --- a/lang/ast/ast.go +++ b/lang/ast/ast.go @@ -199,6 +199,8 @@ const MaxExprDepth = 255 // For slices, like "LHS[MHS:RHS]", ID0 is IDColon. // // For selectors, like "LHS.ID1", ID0 is IDDot. +// +// For limits, like "limit (LHS) RHS", ID0 is IDLimit. type Expr Node func (n *Expr) Node() *Node { return (*Node)(n) } diff --git a/lang/check/bounds.go b/lang/check/bounds.go index 983d3cba..fac9b9fb 100644 --- a/lang/check/bounds.go +++ b/lang/check/bounds.go @@ -339,7 +339,10 @@ func (q *checker) bcheckAssignment1(lhs *a.Expr, op t.ID, rhs *a.Expr) error { if err != nil { return err } - if rMin.Cmp(lMin) < 0 || rMax.Cmp(lMax) > 0 { + + if (rMin != nil && lMin != nil && rMin.Cmp(lMin) < 0) || + (rMax != nil && lMax != nil && rMax.Cmp(lMax) > 0) { + if op == t.IDEq { return fmt.Errorf("check: expression %q bounds [%v..%v] is not within bounds [%v..%v]", rhs.String(q.tm), rMin, rMax, lMin, lMax) @@ -663,6 +666,17 @@ func (q *checker) bcheckExprOther(n *a.Expr, depth uint32) (*big.Int, *big.Int, } return nil, nil, nil } + // TODO: delete this hack that only matches "foo.decode(etc)". + if isDecode(q.tm, n) { + for _, aNode := range n.Args() { + a := aNode.Arg().Value() + _, _, err := q.bcheckExpr(a, depth) + if err != nil { + return nil, nil, err + } + } + return nil, nil, nil + } return nil, nil, fmt.Errorf("check: unrecognized token.Key (0x%X) for bcheckExprOther", n.ID0().Key()) case t.KeyOpenBracket: @@ -708,6 +722,9 @@ func (q *checker) bcheckExprOther(n *a.Expr, depth uint32) (*big.Int, *big.Int, return nil, nil, err } + case t.KeyLimit: + return nil, nil, nil + default: return nil, nil, fmt.Errorf("check: unrecognized token.Key (0x%X) for bcheckExprOther", n.ID0().Key()) } diff --git a/lang/check/check.go b/lang/check/check.go index 53190787..c4fa27cf 100644 --- a/lang/check/check.go +++ b/lang/check/check.go @@ -53,6 +53,7 @@ func trimQuotes(s string) string { var ( typeExprBool = a.NewTypeExpr(0, t.IDBool, nil, nil, nil) typeExprIdeal = a.NewTypeExpr(0, t.IDDoubleZ, nil, nil, nil) + typeExprU64 = a.NewTypeExpr(0, t.IDU64, nil, nil, nil) // TODO: delete this. typeExprPlaceholder = a.NewTypeExpr(0, t.IDU8, nil, nil, nil) diff --git a/lang/check/type.go b/lang/check/type.go index 3017e11f..78a2bb5d 100644 --- a/lang/check/type.go +++ b/lang/check/type.go @@ -384,6 +384,22 @@ func (q *checker) tcheckExprOther(n *a.Expr, depth uint32) error { n.SetMType(typeExprPlaceholder) // HACK. return nil } + // TODO: delete this hack that only matches "foo.decode(etc)". + if isDecode(q.tm, n) { + foo := n.LHS().Expr().LHS().Expr() + if err := q.tcheckExpr(foo, depth); err != nil { + return err + } + n.LHS().SetTypeChecked() + n.LHS().Expr().SetMType(typeExprPlaceholder) // HACK. + for _, o := range n.Args() { + if err := q.tcheckArg(o.Arg(), depth); err != nil { + return err + } + } + n.SetMType(typeExprPlaceholder) // HACK. + return nil + } case t.KeyOpenBracket: // n is an index. @@ -397,12 +413,12 @@ func (q *checker) tcheckExprOther(n *a.Expr, depth uint32) error { } lTyp := lhs.MType() if lTyp.Decorator().Key() != t.KeyOpenBracket { - return fmt.Errorf("%s is an array-index expression but %s has type %s, not an array type", + return fmt.Errorf("check: %s is an array-index expression but %s has type %s, not an array type", n.String(q.tm), lhs.String(q.tm), lTyp.String(q.tm)) } rTyp := rhs.MType() if !rTyp.IsNumTypeOrIdeal() { - return fmt.Errorf("%s is an array-index expression but %s has type %s, not a numeric type", + return fmt.Errorf("check: %s is an array-index expression but %s has type %s, not a numeric type", n.String(q.tm), rhs.String(q.tm), rTyp.String(q.tm)) } n.SetMType(lTyp.Inner()) @@ -414,6 +430,34 @@ func (q *checker) tcheckExprOther(n *a.Expr, depth uint32) error { case t.KeyDot: return q.tcheckDot(n, depth) + + case t.KeyLimit: + lhs := n.LHS().Expr() + if err := q.tcheckExpr(lhs, depth); err != nil { + return err + } + if lhs.Impure() { + return fmt.Errorf(`check: limit count %q is not pure`, lhs.String(q.tm)) + } + lTyp := lhs.MType() + if !lTyp.IsIdeal() && !lTyp.EqIgnoringRefinements(typeExprU64) { + return fmt.Errorf("check: limit count %q type %q not compatible with u64", + lhs.String(q.tm), lTyp.String(q.tm)) + } + rhs := n.RHS().Expr() + if err := q.tcheckExpr(rhs, depth); err != nil { + return err + } + if rhs.Impure() { + return fmt.Errorf("check: limit arg %q is not pure", rhs.String(q.tm)) + } + rTyp := rhs.MType() + if rTyp.Decorator() != 0 || (rTyp.Name().Key() != t.KeyReader1 && rTyp.Name().Key() != t.KeyWriter1) { + return fmt.Errorf(`check: limit arg %q type %q not "reader1" or "writer1"`, + rhs.String(q.tm), rTyp.String(q.tm)) + } + n.SetMType(rTyp) + return nil } return fmt.Errorf("check: unrecognized token.Key (0x%X) for tcheckExprOther", n.ID0().Key()) } @@ -482,6 +526,15 @@ func isSetLiteralWidth(tm *t.Map, n *a.Expr) bool { return n.ID0().Key() == t.KeyDot && n.ID1() == tm.ByName("set_literal_width") } +func isDecode(tm *t.Map, n *a.Expr) bool { + // TODO: check that n.Args() is "(dst:bar, src:baz)". + if n.ID0().Key() != t.KeyOpenParen || !n.CallSuspendible() || len(n.Args()) != 2 { + return false + } + n = n.LHS().Expr() + return n.ID0().Key() == t.KeyDot && n.ID1() == tm.ByName("decode") +} + func (q *checker) tcheckDot(n *a.Expr, depth uint32) error { lhs := n.LHS().Expr() if err := q.tcheckExpr(lhs, depth); err != nil { diff --git a/lang/parse/parse.go b/lang/parse/parse.go index 4be3b008..7fbf1ea3 100644 --- a/lang/parse/parse.go +++ b/lang/parse/parse.go @@ -565,9 +565,16 @@ func (p *parser) parseStatement1() (*a.Node, error) { value := (*a.Expr)(nil) if p.peek1().Key() == t.KeyEq { p.src = p.src[1:] - value, err = p.parseExpr() - if err != nil { - return nil, err + if p.peek1().Key() == t.KeyLimit { + value, err = p.parseLimitExpr() + if err != nil { + return nil, err + } + } else { + value, err = p.parseExpr() + if err != nil { + return nil, err + } } } return a.NewVar(id, typ, value).Node(), nil @@ -639,6 +646,33 @@ func (p *parser) parseArgNode() (*a.Node, error) { return a.NewArg(name, value).Node(), nil } +func (p *parser) parseLimitExpr() (*a.Expr, error) { + if x := p.peek1().Key(); x != t.KeyLimit { + got := p.tm.ByKey(x) + return nil, fmt.Errorf(`parse: expected "limit", got %q at %s:%d`, got, p.filename, p.line()) + } + p.src = p.src[1:] + if x := p.peek1().Key(); x != t.KeyOpenParen { + got := p.tm.ByKey(x) + return nil, fmt.Errorf(`parse: expected "(", got %q at %s:%d`, got, p.filename, p.line()) + } + p.src = p.src[1:] + lhs, err := p.parseExpr() + if err != nil { + return nil, err + } + if x := p.peek1().Key(); x != t.KeyCloseParen { + got := p.tm.ByKey(x) + return nil, fmt.Errorf(`parse: expected ")", got %q at %s:%d`, got, p.filename, p.line()) + } + p.src = p.src[1:] + rhs, err := p.parseExpr() + if err != nil { + return nil, err + } + return a.NewExpr(0, t.IDLimit, 0, lhs.Node(), nil, rhs.Node(), nil), nil +} + func (p *parser) parseExpr() (*a.Expr, error) { lhs, err := p.parseOperand() if err != nil { diff --git a/lang/token/list.go b/lang/token/list.go index baec0c42..65a8fd6c 100644 --- a/lang/token/list.go +++ b/lang/token/list.go @@ -209,6 +209,7 @@ const ( KeyPri = Key(IDPri >> KeyShift) KeyError = Key(IDError >> KeyShift) KeyStatus = Key(IDStatus >> KeyShift) + KeyLimit = Key(IDLimit >> KeyShift) KeyFalse = Key(IDFalse >> KeyShift) KeyTrue = Key(IDTrue >> KeyShift) @@ -366,6 +367,7 @@ const ( IDPri = ID(0x72<