// Copyright 2017 The Wuffs Authors. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //go:generate go run gen.go package cgen import ( "bytes" "flag" "fmt" "io/ioutil" "math/big" "os" "os/exec" "path" "path/filepath" "strings" "github.com/google/wuffs/lang/base38" "github.com/google/wuffs/lang/builtin" "github.com/google/wuffs/lang/check" "github.com/google/wuffs/lang/generate" cf "github.com/google/wuffs/cmd/commonflags" a "github.com/google/wuffs/lang/ast" t "github.com/google/wuffs/lang/token" ) var ( zero = big.NewInt(0) one = big.NewInt(1) ) // Prefixes are prepended to names to form a namespace and to avoid e.g. // "double" being a valid Wuffs variable name but not a valid C one. const ( aPrefix = "a_" // Function argument. bPrefix = "b_" // Derived from a function argument. cPrefix = "c_" // Coroutine state. fPrefix = "f_" // Struct field. iPrefix = "i_" // Iterate variable. oPrefix = "o_" // Temporary io_bind variable. tPrefix = "t_" // Temporary local variable. vPrefix = "v_" // Local variable. ) // Do transpiles a Wuffs program to a C program. // // The arguments list the source Wuffs files. If no arguments are given, it // reads from stdin. // // The generated program is written to stdout. func Do(args []string) error { flags := flag.FlagSet{} cformatterFlag := flags.String("cformatter", cf.CformatterDefault, cf.CformatterUsage) return generate.Do(&flags, args, func(pkgName string, tm *t.Map, c *check.Checker, files []*a.File) ([]byte, error) { if !cf.IsAlphaNumericIsh(*cformatterFlag) { return nil, fmt.Errorf("bad -cformatter flag value %q", *cformatterFlag) } g := &gen{ PKGPREFIX: "WUFFS_" + strings.ToUpper(pkgName) + "__", pkgPrefix: "wuffs_" + pkgName + "__", pkgName: pkgName, tm: tm, checker: c, files: files, } unformatted, err := g.generate() if err != nil { return nil, err } stdout := &bytes.Buffer{} cmd := exec.Command(*cformatterFlag, "-style=Chromium") cmd.Stdin = bytes.NewReader(unformatted) cmd.Stdout = stdout cmd.Stderr = os.Stderr if err := cmd.Run(); err != nil { return nil, err } return stdout.Bytes(), nil }) } const ( maxNamespacedStatusCode = 255 statusCodeNamespaceMask = 1< maxNamespacedStatusCode { panic("too many built-in statuses") } } type replacementPolicy bool const ( replaceNothing = replacementPolicy(false) replaceCallSuspendibles = replacementPolicy(true) ) // parenthesesPolicy controls whether to print the outer parentheses in an // expression like "(x + y)". An "if" or "while" will print their own // parentheses for "if (expr)" because they need to be able to say "if (x)". // But a double-parenthesized expression like "if ((x == y))" is a clang // warning (-Wparentheses-equality) and we like to compile with -Wall -Werror. type parenthesesPolicy bool const ( parenthesesMandatory = parenthesesPolicy(false) parenthesesOptional = parenthesesPolicy(true) ) type visibility uint32 const ( bothPubPri = visibility(iota) pubOnly priOnly ) const ( maxIOBinds = 100 maxIOBindInFields = 100 maxTemp = 10000 ) type status struct { name string msg string keyword t.ID } type buffer []byte func (b *buffer) Write(p []byte) (int, error) { *b = append(*b, p...) return len(p), nil } func (b *buffer) printf(format string, args ...interface{}) { fmt.Fprintf(b, format, args...) } func (b *buffer) writeb(x byte) { *b = append(*b, x) } func (b *buffer) writes(s string) { *b = append(*b, s...) } func (b *buffer) writex(s []byte) { *b = append(*b, s...) } type gen struct { PKGPREFIX string // e.g. "WUFFS_JPEG__" pkgPrefix string // e.g. "wuffs_jpeg__" pkgName string // e.g. "jpeg" tm *t.Map checker *check.Checker files []*a.File statusList []status statusMap map[t.QID]status structList []*a.Struct structMap map[t.QID]*a.Struct usesList []string usesMap map[string]struct{} currFunk funk funks map[t.QQID]funk wuffsRoot string } func (g *gen) generate() ([]byte, error) { b := new(buffer) g.statusMap = map[t.QID]status{} if err := g.forEachStatus(b, bothPubPri, (*gen).gatherStatuses); err != nil { return nil, err } // Make a topologically sorted list of structs. unsortedStructs := []*a.Struct(nil) for _, file := range g.files { for _, tld := range file.TopLevelDecls() { if tld.Kind() == a.KStruct { unsortedStructs = append(unsortedStructs, tld.Struct()) } } } var ok bool g.structList, ok = a.TopologicalSortStructs(unsortedStructs) if !ok { return nil, fmt.Errorf("cyclical struct definitions") } g.structMap = map[t.QID]*a.Struct{} for _, n := range g.structList { g.structMap[n.QID()] = n } g.funks = map[t.QQID]funk{} if err := g.forEachFunc(nil, bothPubPri, (*gen).gatherFuncImpl); err != nil { return nil, err } if err := g.genHeader(b); err != nil { return nil, err } b.writes("// C HEADER ENDS HERE.\n\n") if err := g.genImpl(b); err != nil { return nil, err } return *b, nil } func (g *gen) genHeader(b *buffer) error { includeGuard := "WUFFS_" + strings.ToUpper(g.pkgName) + "_H" b.printf("#ifndef %s\n#define %s\n\n", includeGuard, includeGuard) b.printf("// Code generated by wuffs-c. DO NOT EDIT.\n\n") b.writes(baseHeader) b.writeb('\n') b.writes("// ---------------- Use Declarations\n\n") if err := g.forEachUse(b, (*gen).writeUse); err != nil { return err } b.writes("\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n") b.writes("// ---------------- Status Codes\n\n") b.writes(statusCodeDescription) b.printf("//\n// Do not manipulate these bits directly; they are private implementation\n"+ "// details. Use methods such as %sstatus__is_error instead.\n", g.pkgPrefix) b.printf("typedef int32_t %sstatus;\n\n", g.pkgPrefix) pkgID := g.checker.PackageID() b.printf("#define %spackageid %d // 0x%08X\n\n", g.pkgPrefix, pkgID, pkgID) for i, z := range builtin.StatusList { code := uint32(0) if z.Keyword == t.IDError { code |= 1 << 31 } code |= uint32(i) b.printf("#define %s %d // 0x%08X\n", strings.ToUpper(g.cName(z.String())), int32(code), code) } b.writes("\n") if len(g.statusList) > maxNamespacedStatusCode { return fmt.Errorf("too many status codes") } for i, s := range g.statusList { code := pkgID << statusCodeNamespaceShift if s.keyword == t.IDError { code |= 1 << 31 } code |= uint32(i) b.printf("#define %s %d // 0x%08X\n", s.name, int32(code), code) } b.writes("\n") b.printf("bool %sstatus__is_error(%sstatus s);\n\n", g.pkgPrefix, g.pkgPrefix) b.printf("const char* %sstatus__string(%sstatus s);\n\n", g.pkgPrefix, g.pkgPrefix) b.writes("// ---------------- Public Consts\n\n") if err := g.forEachConst(b, pubOnly, (*gen).writeConst); err != nil { return err } b.writes("// ---------------- Structs\n\n") for _, n := range g.structList { if err := g.writeStruct(b, n); err != nil { return err } } b.writes("// ---------------- Public Initializer Prototypes\n\n") for _, n := range g.structList { if n.Public() { if err := g.writeInitializerPrototype(b, n); err != nil { return err } } } b.writes("// ---------------- Public Function Prototypes\n\n") if err := g.forEachFunc(b, pubOnly, (*gen).writeFuncPrototype); err != nil { return err } b.writes("\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n") b.printf("#endif // %s\n\n", includeGuard) return nil } func (g *gen) genImpl(b *buffer) error { b.writes("#ifndef WUFFS_BASE_IMPL_H\n#define WUFFS_BASE_IMPL_H\n\n") b.writes(baseImpl) b.writes("\n") b.printf("static const char* wuffs_base__status__strings[%d] = {\n", len(builtin.StatusList)) for _, z := range builtin.StatusList { b.printf("%q,", z.Message) } b.writes("};\n\n") b.writes("#endif // WUFFS_BASE_IMPL_H\n\n") b.writes("// ---------------- Status Codes Implementations\n\n") b.printf("bool %sstatus__is_error(%sstatus s) { return s < 0; }\n\n", g.pkgPrefix, g.pkgPrefix) b.printf("const char* %sstatus__strings[%d] = {\n", g.pkgPrefix, len(g.statusList)) for _, s := range g.statusList { b.printf("%q,", g.pkgName+": "+s.msg) } b.writes("};\n\n") b.printf("const char* %sstatus__string(%sstatus s) {\n", g.pkgPrefix, g.pkgPrefix) b.printf("const char** a = NULL;\n") b.printf("uint32_t n = 0;\n") b.printf("switch ((s >> %d) & 0x%X) {\n", statusCodeNamespaceShift, statusCodeNamespaceMask) b.printf("case 0: a = wuffs_base__status__strings; n = %d; break;\n", len(builtin.StatusList)) b.printf("case %spackageid: a = %sstatus__strings; n = %d; break;\n", g.pkgPrefix, g.pkgPrefix, len(g.statusList)) for _, u := range g.usesList { // TODO: is path.Base always correct? Should we check // validName(packageName)? useePkgName := path.Base(u) b.printf("case wuffs_%s__packageid: return wuffs_%s__status__string(s);\n", useePkgName, useePkgName) } b.printf("}\n") b.printf("uint32_t i = s & 0x%X;\n", 1<private_impl.status = WUFFS_ETC__ERROR_BAD_WUFFS_VERSION;" // regardless of the sizeof(*self) struct reserved by the caller and even // if the caller and callee were built with different versions. structName := n.QID().Str(g.tm) b.writes("typedef struct {\n") b.writes("// Do not access the private_impl's fields directly. There is no API/ABI\n") b.writes("// compatibility or safety guarantee if you do so. Instead, use the\n") b.printf("// %s%s__etc functions.\n", g.pkgPrefix, structName) b.writes("//\n") b.writes("// In C++, these fields would be \"private\", but C does not support that.\n") b.writes("//\n") b.writes("// It is a struct, not a struct*, so that it can be stack allocated.\n") b.writes("struct {\n") if n.Suspendible() { b.printf("%sstatus status;\n", g.pkgPrefix) b.writes("uint32_t magic;\n") b.writes("\n") } for _, o := range n.Fields() { o := o.Field() if err := g.writeCTypeName(b, o.XType(), fPrefix, o.Name().Str(g.tm)); err != nil { return err } b.writes(";\n") } if n.Suspendible() { b.writeb('\n') for _, file := range g.files { for _, tld := range file.TopLevelDecls() { if tld.Kind() != a.KFunc { continue } o := tld.Func() if o.Receiver() != n.QID() || !o.Suspendible() { continue } k := g.funks[o.QQID()] if k.coroSuspPoint == 0 && !k.usesScratch { continue } // TODO: allow max depth > 1 for recursive coroutines. const maxDepth = 1 b.writes("struct {\n") if k.coroSuspPoint != 0 { b.writes("uint32_t coro_susp_point;\n") if err := g.writeVars(b, o.Body(), true, true); err != nil { return err } } if k.usesScratch { b.writes("uint64_t scratch;\n") } b.printf("} %s%s[%d];\n", cPrefix, o.FuncName().Str(g.tm), maxDepth) } } } b.printf("} private_impl;\n } %s%s;\n\n", g.pkgPrefix, structName) return nil } var ( wuffsBaseHeaderHStart = []byte("#ifndef WUFFS_BASE_HEADER_H\n") wuffsBaseHeaderHEnd = []byte("#endif // WUFFS_BASE_HEADER_H\n") ) func (g *gen) writeUse(b *buffer, n *a.Use) error { useDirname := g.tm.ByID(n.Path()) useDirname, _ = t.Unescape(useDirname) // TODO: sanity check useDirname via commonflags.IsValidUsePath? if g.usesMap == nil { g.usesMap = map[string]struct{}{} } else if _, ok := g.usesMap[useDirname]; ok { return nil } g.usesList = append(g.usesList, useDirname) g.usesMap[useDirname] = struct{}{} if g.wuffsRoot == "" { var err error g.wuffsRoot, err = generate.WuffsRoot() if err != nil { return err } } hdrFilename := filepath.Join(g.wuffsRoot, "gen", "h", filepath.FromSlash(useDirname)+".h") hdr, err := ioutil.ReadFile(hdrFilename) if err != nil { return err } b.printf("// ---------------- BEGIN USE %q\n\n", useDirname) // Inline the previously generated .h file, stripping out the redundant // copy of the WUFFS_BASE_HEADER_H code. if i := bytes.Index(hdr, wuffsBaseHeaderHStart); i < 0 { return fmt.Errorf("use %q: previously generated header %q could not be inlined", useDirname, hdrFilename) } else { b.Write(hdr[:i]) hdr = hdr[i+len(wuffsBaseHeaderHStart):] } if i := bytes.Index(hdr, wuffsBaseHeaderHEnd); i < 0 { return fmt.Errorf("use %q: previously generated header %q could not be inlined", useDirname, hdrFilename) } else { b.Write(hdr[i+len(wuffsBaseHeaderHEnd):]) } b.writeb('\n') b.printf("// ---------------- END USE %q\n\n", useDirname) return nil } func (g *gen) writeInitializerSignature(b *buffer, n *a.Struct, public bool) error { structName := n.QID().Str(g.tm) if public { b.printf("// %s%s__initialize is an initializer function.\n", g.pkgPrefix, structName) b.printf("//\n") b.printf("// It should be called before any other %s%s__* function.\n", g.pkgPrefix, structName) b.printf("//\n") b.printf("// Pass WUFFS_VERSION and 0 for wuffs_version and for_internal_use_only.\n") } b.printf("void %s%s__initialize(%s%s *self", g.pkgPrefix, structName, g.pkgPrefix, structName) b.printf(", uint32_t wuffs_version, uint32_t for_internal_use_only") b.printf(")") return nil } func (g *gen) writeInitializerPrototype(b *buffer, n *a.Struct) error { if !n.Suspendible() { return nil } if err := g.writeInitializerSignature(b, n, n.Public()); err != nil { return err } b.writes(";\n\n") return nil } func (g *gen) writeInitializerImpl(b *buffer, n *a.Struct) error { if !n.Suspendible() { return nil } if err := g.writeInitializerSignature(b, n, false); err != nil { return err } b.printf("{\n") b.printf("if (!self) { return; }\n") b.printf("if (wuffs_version != WUFFS_VERSION) {\n") b.printf("self->private_impl.status = %sERROR_BAD_WUFFS_VERSION;\n", g.PKGPREFIX) b.printf("return;\n") b.printf("}\n") b.writes("if (for_internal_use_only != WUFFS_BASE__ALREADY_ZEROED) {" + "memset(self, 0, sizeof(*self)); }\n") b.writes("self->private_impl.magic = WUFFS_BASE__MAGIC;\n") for _, f := range n.Fields() { f := f.Field() if dv := f.DefaultValue(); dv != nil { // TODO: set default values for array types. b.printf("self->private_impl.%s%s = %d;\n", fPrefix, f.Name().Str(g.tm), dv.ConstValue()) } } // Call any ctors on sub-structs. for _, f := range n.Fields() { f := f.Field() x := f.XType() if x != x.Innermost() { // TODO: arrays of sub-structs. continue } prefix := g.pkgPrefix qid := x.QID() if qid[0] == t.IDBase { // Base types don't need further initialization. continue } else if qid[0] != 0 { // See gen.writeCTypeName for a related TODO with otherPkg. otherPkg := g.tm.ByID(qid[0]) prefix = "wuffs_" + otherPkg + "__" } else if g.structMap[qid] == nil { continue } b.printf("%s%s__initialize(&self->private_impl.%s%s, WUFFS_VERSION, WUFFS_BASE__ALREADY_ZEROED);\n", prefix, qid[1].Str(g.tm), fPrefix, f.Name().Str(g.tm)) } b.writes("}\n\n") return nil }