From e66f1cb2364cecc5d85c2571673f700583a73ef9 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Sun, 28 May 2017 12:34:12 +1000 Subject: [PATCH] Avoid double-zeroing containee struct's memory. --- cmd/internal/cgen/cgen.go | 53 +++++++++++++++++++++++++++++---------- gen/c/gif.c | 22 +++++++++++++--- gen/h/gif.h | 8 +++++- test/c/gif/basic.c | 4 +-- 4 files changed, 68 insertions(+), 19 deletions(-) diff --git a/cmd/internal/cgen/cgen.go b/cmd/internal/cgen/cgen.go index 69af33f2..038efc0f 100644 --- a/cmd/internal/cgen/cgen.go +++ b/cmd/internal/cgen/cgen.go @@ -59,7 +59,7 @@ func (g *Generator) Generate(pkgName string, m *t.IDMap, files []*a.File) ([]byt } b.WriteString("// ---------------- Public Constructor and Destructor Prototypes\n\n") - if err := forEachStruct(b, pkgName, m, files, pubOnly, writeCtorPrototypes); err != nil { + if err := forEachStruct(b, pkgName, m, files, pubOnly, writeCtorPrototypesPub); err != nil { return nil, err } @@ -81,7 +81,7 @@ func (g *Generator) Generate(pkgName string, m *t.IDMap, files []*a.File) ([]byt } b.WriteString("// ---------------- Private Constructor and Destructor Prototypes\n\n") - if err := forEachStruct(b, pkgName, m, files, priOnly, writeCtorPrototypes); err != nil { + if err := forEachStruct(b, pkgName, m, files, priOnly, writeCtorPrototypesPri); err != nil { return nil, err } @@ -97,6 +97,12 @@ func (g *Generator) Generate(pkgName string, m *t.IDMap, files []*a.File) ([]byt b.WriteString("//\n") b.WriteString("// Its (non-zero) value is arbitrary, based on md5sum(\"puffs\").\n") b.WriteString("#define PUFFS_MAGIC (0xCB3699CCU)\n\n") + b.WriteString("// PUFFS_ALREADY_ZEROED is passed from a container struct's constructor to a\n") + b.WriteString("// containee struct's constructor when the container has already zeroed the\n") + b.WriteString("// containee's memory.\n") + b.WriteString("//\n") + b.WriteString("// Its (non-zero) value is arbitrary, based on md5sum(\"zeroed\").\n") + b.WriteString("#define PUFFS_ALREADY_ZEROED (0x68602EF1U)\n\n") if err := forEachStruct(b, pkgName, m, files, bothPubPri, writeCtorImpls); err != nil { return nil, err } @@ -161,21 +167,41 @@ func writeStruct(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct) error return nil } -func writeCtorSignature(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct, ctor string) { +func writeCtorSignature(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct, public bool, ctor bool) { structName := n.Name().String(m) - fmt.Fprintf(b, "void puffs_%s_%s_%s(puffs_%s_%s *self", pkgName, structName, ctor, pkgName, structName) - if ctor == "constructor" { - fmt.Fprintf(b, ", uint32_t puffs_version") + ctorName := "destructor" + if ctor { + ctorName = "constructor" + if public { + fmt.Fprintf(b, "// puffs_%s_%s_%s is a constructor function.\n", pkgName, structName, ctorName) + fmt.Fprintf(b, "//\n") + fmt.Fprintf(b, "// It should be called before any other puffs_%s_%s_* function.\n", + pkgName, structName) + fmt.Fprintf(b, "//\n") + fmt.Fprintf(b, "// Pass PUFFS_VERSION and 0 for puffs_version and for_internal_use_only.\n") + } + } + fmt.Fprintf(b, "void puffs_%s_%s_%s(puffs_%s_%s *self", pkgName, structName, ctorName, pkgName, structName) + if ctor { + fmt.Fprintf(b, ", uint32_t puffs_version, uint32_t for_internal_use_only") } fmt.Fprintf(b, ")") } -func writeCtorPrototypes(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct) error { +func writeCtorPrototypesPub(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct) error { + return writeCtorPrototypes(b, pkgName, m, n, true) +} + +func writeCtorPrototypesPri(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct) error { + return writeCtorPrototypes(b, pkgName, m, n, false) +} + +func writeCtorPrototypes(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct, public bool) error { if !n.Suspendible() { return nil } - for _, ctor := range []string{"constructor", "destructor"} { - writeCtorSignature(b, pkgName, m, n, ctor) + for _, ctor := range []bool{true, false} { + writeCtorSignature(b, pkgName, m, n, public, ctor) b.WriteString(";\n\n") } return nil @@ -185,18 +211,19 @@ func writeCtorImpls(b *bytes.Buffer, pkgName string, m *t.IDMap, n *a.Struct) er if !n.Suspendible() { return nil } - for _, ctor := range []string{"constructor", "destructor"} { - writeCtorSignature(b, pkgName, m, n, ctor) + for _, ctor := range []bool{true, false} { + writeCtorSignature(b, pkgName, m, n, false, ctor) fmt.Fprintf(b, "{\n") fmt.Fprintf(b, "if (!self) { return; }\n") - if ctor == "constructor" { + if ctor { fmt.Fprintf(b, "if (puffs_version != PUFFS_VERSION) {\n") fmt.Fprintf(b, "self->status = puffs_%s_error_bad_version;\n", pkgName) fmt.Fprintf(b, "return;\n") fmt.Fprintf(b, "}\n") - b.WriteString("memset(self, 0, sizeof(*self));\n") + b.WriteString("if (for_internal_use_only != PUFFS_ALREADY_ZEROED) {" + + "memset(self, 0, sizeof(*self)); }\n") b.WriteString("self->magic = PUFFS_MAGIC;\n") // TODO: set any non-zero default values. diff --git a/gen/c/gif.c b/gen/c/gif.c index 587e326c..8264134d 100644 --- a/gen/c/gif.c +++ b/gen/c/gif.c @@ -60,8 +60,14 @@ typedef struct { // ---------------- Public Constructor and Destructor Prototypes +// puffs_gif_lzw_decoder_constructor is a constructor function. +// +// It should be called before any other puffs_gif_lzw_decoder_* function. +// +// Pass PUFFS_VERSION and 0 for puffs_version and for_internal_use_only. void puffs_gif_lzw_decoder_constructor(puffs_gif_lzw_decoder* self, - uint32_t puffs_version); + uint32_t puffs_version, + uint32_t for_internal_use_only); void puffs_gif_lzw_decoder_destructor(puffs_gif_lzw_decoder* self); @@ -90,8 +96,16 @@ puffs_gif_status puffs_gif_lzw_decoder_decode(puffs_gif_lzw_decoder* self); // Its (non-zero) value is arbitrary, based on md5sum("puffs"). #define PUFFS_MAGIC (0xCB3699CCU) +// PUFFS_ALREADY_ZEROED is passed from a container struct's constructor to a +// containee struct's constructor when the container has already zeroed the +// containee's memory. +// +// Its (non-zero) value is arbitrary, based on md5sum("zeroed"). +#define PUFFS_ALREADY_ZEROED (0x68602EF1U) + void puffs_gif_lzw_decoder_constructor(puffs_gif_lzw_decoder* self, - uint32_t puffs_version) { + uint32_t puffs_version, + uint32_t for_internal_use_only) { if (!self) { return; } @@ -99,7 +113,9 @@ void puffs_gif_lzw_decoder_constructor(puffs_gif_lzw_decoder* self, self->status = puffs_gif_error_bad_version; return; } - memset(self, 0, sizeof(*self)); + if (for_internal_use_only != PUFFS_ALREADY_ZEROED) { + memset(self, 0, sizeof(*self)); + } self->magic = PUFFS_MAGIC; } diff --git a/gen/h/gif.h b/gen/h/gif.h index 4a2d6652..123584e3 100644 --- a/gen/h/gif.h +++ b/gen/h/gif.h @@ -60,8 +60,14 @@ typedef struct { // ---------------- Public Constructor and Destructor Prototypes +// puffs_gif_lzw_decoder_constructor is a constructor function. +// +// It should be called before any other puffs_gif_lzw_decoder_* function. +// +// Pass PUFFS_VERSION and 0 for puffs_version and for_internal_use_only. void puffs_gif_lzw_decoder_constructor(puffs_gif_lzw_decoder* self, - uint32_t puffs_version); + uint32_t puffs_version, + uint32_t for_internal_use_only); void puffs_gif_lzw_decoder_destructor(puffs_gif_lzw_decoder* self); diff --git a/test/c/gif/basic.c b/test/c/gif/basic.c index 9797255f..18aacb50 100644 --- a/test/c/gif/basic.c +++ b/test/c/gif/basic.c @@ -36,7 +36,7 @@ void test_null_receiver() { void test_puffs_version_bad() { puffs_gif_lzw_decoder dec; - puffs_gif_lzw_decoder_constructor(&dec, 0); // 0 is not PUFFS_VERSION. + puffs_gif_lzw_decoder_constructor(&dec, 0, 0); // 0 is not PUFFS_VERSION. if (dec.status != puffs_gif_error_bad_version) { FAIL("test_puffs_version_bad: status: got %d, want %d", dec.status, puffs_gif_error_bad_version); @@ -48,7 +48,7 @@ cleanup0: void test_puffs_version_good() { puffs_gif_lzw_decoder dec; - puffs_gif_lzw_decoder_constructor(&dec, PUFFS_VERSION); + puffs_gif_lzw_decoder_constructor(&dec, PUFFS_VERSION, 0); if (dec.magic != PUFFS_MAGIC) { FAIL("test_puffs_version_good: magic: got %u, want %u", dec.magic, PUFFS_MAGIC);