package gen import ( "sources.truenas.cloud/code/avo/internal/api" "sources.truenas.cloud/code/avo/internal/inst" "sources.truenas.cloud/code/avo/internal/prnt" "sources.truenas.cloud/code/avo/printer" ) type godata struct { cfg printer.Config prnt.Generator } // NewGoData writes a Go variable containing the instructions database. This is // intended to provide a more friendly version of the instruction database, // rather than having to use the raw data sources all the time. func NewGoData(cfg printer.Config) Interface { return GoFmt(&godata{cfg: cfg}) } func (g *godata) Generate(is []inst.Instruction) ([]byte, error) { g.Printf("// %s\n\n", g.cfg.GeneratedWarning()) g.Printf("package inst\n\n") g.Printf("var Instructions = []Instruction{\n") for _, i := range is { g.Printf("{\n") g.Printf("Opcode: %#v,\n", i.Opcode) if i.AliasOf != "" { g.Printf("AliasOf: %#v,\n", i.AliasOf) } g.Printf("Summary: %#v,\n", i.Summary) g.Printf("Forms: []Form{\n") for _, f := range i.Forms { g.Printf("{\n") if f.ISA != nil { g.Printf("ISA: %#v,\n", f.ISA) } if f.Operands != nil { g.Printf("Operands: []Operand{\n") for _, op := range f.Operands { g.Printf("{Type: %#v, Action: %#v},\n", op.Type, op.Action) } g.Printf("},\n") } if f.ImplicitOperands != nil { g.Printf("ImplicitOperands: []ImplicitOperand{\n") for _, op := range f.ImplicitOperands { g.Printf("{Register: %#v, Action: %#v},\n", op.Register, op.Action) } g.Printf("},\n") } g.Printf("EncodingType: %#v,\n", f.EncodingType) for _, flag := range []struct { Field string Enabled bool }{ {"CancellingInputs", f.CancellingInputs}, {"Zeroing", f.Zeroing}, {"EmbeddedRounding", f.EmbeddedRounding}, {"SuppressAllExceptions", f.SuppressAllExceptions}, {"Broadcast", f.Broadcast}, } { if flag.Enabled { g.Printf("%s: true,\n", flag.Field) } } g.Printf("},\n") } g.Printf("},\n") g.Printf("},\n") } g.Printf("}\n") return g.Result() } type godatatest struct { cfg printer.Config prnt.Generator } // NewGoDataTest writes a test case to confirm that NewGoData faithfully // represented the list. The reason for this is that NewGoData uses custom code // to "pretty print" the database so it is somewhat human-readable. In the // process we could easily mistakenly print the database incorrectly. This test // prints the same slice of instructions with the ugly but correct "%#v" format // specifier, and confirms that the two arrays agree. func NewGoDataTest(cfg printer.Config) Interface { return GoFmt(&godatatest{cfg: cfg}) } func (g *godatatest) Generate(is []inst.Instruction) ([]byte, error) { g.Printf("// %s\n\n", g.cfg.GeneratedWarning()) g.NL() g.Printf("package inst_test\n\n") g.Printf(`import ( "reflect" "testing" "%s/internal/inst" ) `, api.Package) g.Printf("var raw = %#v\n\n", is) g.Printf(`func TestVerifyInstructionsList(t *testing.T) { if !reflect.DeepEqual(raw, inst.Instructions) { t.Fatal("bad code generation for instructions list") } } `) return g.Result() }