rlp/rlpgen: RLP encoder code generator (#24251)
This change adds a code generator tool for creating EncodeRLP method
implementations. The generated methods will behave identically to the
reflect-based encoder, but run faster because there is no reflection overhead.
Package rlp now provides the EncoderBuffer type for incremental encoding. This
is used by generated code, but the new methods can also be useful for
hand-written encoders.
There is also experimental support for generating DecodeRLP, and some new
methods have been added to the existing Stream type to support this. Creating
decoders with rlpgen is not recommended at this time because the generated
methods create very poor error reporting.
More detail about package rlp changes:
* rlp: externalize struct field processing / validation
This adds a new package, rlp/internal/rlpstruct, in preparation for the
RLP encoder generator.
I think the struct field rules are subtle enough to warrant extracting
this into their own package, even though it means that a bunch of
adapter code is needed for converting to/from rlpstruct.Type.
* rlp: add more decoder methods (for rlpgen)
This adds new methods on rlp.Stream:
- Uint64, Uint32, Uint16, Uint8, BigInt
- ReadBytes for decoding into []byte
- MoreDataInList - useful for optional list elements
* rlp: expose encoder buffer (for rlpgen)
This exposes the internal encoder buffer type for use in EncodeRLP
implementations.
The new EncoderBuffer type is a sort-of 'opaque handle' for a pointer to
encBuffer. It is implemented this way to ensure the global encBuffer pool
is handled correctly.
2022-02-16 17:14:12 +00:00
|
|
|
package main
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"fmt"
|
|
|
|
"go/ast"
|
|
|
|
"go/importer"
|
|
|
|
"go/parser"
|
|
|
|
"go/token"
|
|
|
|
"go/types"
|
|
|
|
"os"
|
|
|
|
"path/filepath"
|
|
|
|
"testing"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Package RLP is loaded only once and reused for all tests.
|
|
|
|
var (
|
|
|
|
testFset = token.NewFileSet()
|
|
|
|
testImporter = importer.ForCompiler(testFset, "source", nil).(types.ImporterFrom)
|
|
|
|
testPackageRLP *types.Package
|
|
|
|
)
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
cwd, err := os.Getwd()
|
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
testPackageRLP, err = testImporter.ImportFrom(pathOfPackageRLP, cwd, 0)
|
|
|
|
if err != nil {
|
|
|
|
panic(fmt.Errorf("can't load package RLP: %v", err))
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
var tests = []string{"uints", "nil", "rawvalue", "optional", "bigint"}
|
|
|
|
|
|
|
|
func TestOutput(t *testing.T) {
|
|
|
|
for _, test := range tests {
|
|
|
|
test := test
|
|
|
|
t.Run(test, func(t *testing.T) {
|
|
|
|
inputFile := filepath.Join("testdata", test+".in.txt")
|
|
|
|
outputFile := filepath.Join("testdata", test+".out.txt")
|
|
|
|
bctx, typ, err := loadTestSource(inputFile, "Test")
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal("error loading test source:", err)
|
|
|
|
}
|
|
|
|
output, err := bctx.generate(typ, true, true)
|
|
|
|
if err != nil {
|
|
|
|
t.Fatal("error in generate:", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Set this environment variable to regenerate the test outputs.
|
|
|
|
if os.Getenv("WRITE_TEST_FILES") != "" {
|
2022-05-16 09:59:35 +00:00
|
|
|
os.WriteFile(outputFile, output, 0644)
|
rlp/rlpgen: RLP encoder code generator (#24251)
This change adds a code generator tool for creating EncodeRLP method
implementations. The generated methods will behave identically to the
reflect-based encoder, but run faster because there is no reflection overhead.
Package rlp now provides the EncoderBuffer type for incremental encoding. This
is used by generated code, but the new methods can also be useful for
hand-written encoders.
There is also experimental support for generating DecodeRLP, and some new
methods have been added to the existing Stream type to support this. Creating
decoders with rlpgen is not recommended at this time because the generated
methods create very poor error reporting.
More detail about package rlp changes:
* rlp: externalize struct field processing / validation
This adds a new package, rlp/internal/rlpstruct, in preparation for the
RLP encoder generator.
I think the struct field rules are subtle enough to warrant extracting
this into their own package, even though it means that a bunch of
adapter code is needed for converting to/from rlpstruct.Type.
* rlp: add more decoder methods (for rlpgen)
This adds new methods on rlp.Stream:
- Uint64, Uint32, Uint16, Uint8, BigInt
- ReadBytes for decoding into []byte
- MoreDataInList - useful for optional list elements
* rlp: expose encoder buffer (for rlpgen)
This exposes the internal encoder buffer type for use in EncodeRLP
implementations.
The new EncoderBuffer type is a sort-of 'opaque handle' for a pointer to
encBuffer. It is implemented this way to ensure the global encBuffer pool
is handled correctly.
2022-02-16 17:14:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Check if output matches.
|
2022-05-16 09:59:35 +00:00
|
|
|
wantOutput, err := os.ReadFile(outputFile)
|
rlp/rlpgen: RLP encoder code generator (#24251)
This change adds a code generator tool for creating EncodeRLP method
implementations. The generated methods will behave identically to the
reflect-based encoder, but run faster because there is no reflection overhead.
Package rlp now provides the EncoderBuffer type for incremental encoding. This
is used by generated code, but the new methods can also be useful for
hand-written encoders.
There is also experimental support for generating DecodeRLP, and some new
methods have been added to the existing Stream type to support this. Creating
decoders with rlpgen is not recommended at this time because the generated
methods create very poor error reporting.
More detail about package rlp changes:
* rlp: externalize struct field processing / validation
This adds a new package, rlp/internal/rlpstruct, in preparation for the
RLP encoder generator.
I think the struct field rules are subtle enough to warrant extracting
this into their own package, even though it means that a bunch of
adapter code is needed for converting to/from rlpstruct.Type.
* rlp: add more decoder methods (for rlpgen)
This adds new methods on rlp.Stream:
- Uint64, Uint32, Uint16, Uint8, BigInt
- ReadBytes for decoding into []byte
- MoreDataInList - useful for optional list elements
* rlp: expose encoder buffer (for rlpgen)
This exposes the internal encoder buffer type for use in EncodeRLP
implementations.
The new EncoderBuffer type is a sort-of 'opaque handle' for a pointer to
encBuffer. It is implemented this way to ensure the global encBuffer pool
is handled correctly.
2022-02-16 17:14:12 +00:00
|
|
|
if err != nil {
|
|
|
|
t.Fatal("error loading expected test output:", err)
|
|
|
|
}
|
|
|
|
if !bytes.Equal(output, wantOutput) {
|
|
|
|
t.Fatal("output mismatch:\n", string(output))
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func loadTestSource(file string, typeName string) (*buildContext, *types.Named, error) {
|
|
|
|
// Load the test input.
|
2022-05-16 09:59:35 +00:00
|
|
|
content, err := os.ReadFile(file)
|
rlp/rlpgen: RLP encoder code generator (#24251)
This change adds a code generator tool for creating EncodeRLP method
implementations. The generated methods will behave identically to the
reflect-based encoder, but run faster because there is no reflection overhead.
Package rlp now provides the EncoderBuffer type for incremental encoding. This
is used by generated code, but the new methods can also be useful for
hand-written encoders.
There is also experimental support for generating DecodeRLP, and some new
methods have been added to the existing Stream type to support this. Creating
decoders with rlpgen is not recommended at this time because the generated
methods create very poor error reporting.
More detail about package rlp changes:
* rlp: externalize struct field processing / validation
This adds a new package, rlp/internal/rlpstruct, in preparation for the
RLP encoder generator.
I think the struct field rules are subtle enough to warrant extracting
this into their own package, even though it means that a bunch of
adapter code is needed for converting to/from rlpstruct.Type.
* rlp: add more decoder methods (for rlpgen)
This adds new methods on rlp.Stream:
- Uint64, Uint32, Uint16, Uint8, BigInt
- ReadBytes for decoding into []byte
- MoreDataInList - useful for optional list elements
* rlp: expose encoder buffer (for rlpgen)
This exposes the internal encoder buffer type for use in EncodeRLP
implementations.
The new EncoderBuffer type is a sort-of 'opaque handle' for a pointer to
encBuffer. It is implemented this way to ensure the global encBuffer pool
is handled correctly.
2022-02-16 17:14:12 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
f, err := parser.ParseFile(testFset, file, content, 0)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
conf := types.Config{Importer: testImporter}
|
|
|
|
pkg, err := conf.Check("test", testFset, []*ast.File{f}, nil)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Find the test struct.
|
|
|
|
bctx := newBuildContext(testPackageRLP)
|
|
|
|
typ, err := lookupStructType(pkg.Scope(), typeName)
|
|
|
|
if err != nil {
|
|
|
|
return nil, nil, fmt.Errorf("can't find type %s: %v", typeName, err)
|
|
|
|
}
|
|
|
|
return bctx, typ, nil
|
|
|
|
}
|