Add generation instructions to core objects in preparation for Protobuf

pkg/api/resource/quantity.go

@@ -83,6 +83,11 @@ import (
 // This format is intended to make it difficult to use these numbers without
 // writing some sort of special handling code in the hopes that that will
 // cause implementors to also use a fixed point implementation.
+//
+// +protobuf=true
+// +protobuf.embed=QuantityProto
+// +protobuf.options.marshal=false
+// +protobuf.options.(gogoproto.goproto_stringer)=false
 type Quantity struct {
 	// Amount is public, so you can manipulate it if the accessor
 	// functions are not sufficient.

pkg/api/resource/quantity_proto.go

@@ -0,0 +1,80 @@
+// +build proto
+
+/*
+Copyright 2015 The Kubernetes Authors All rights reserved.
+
+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
+
+    http://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.
+*/
+
+package resource
+
+import (
+	"math/big"
+
+	"speter.net/go/exp/math/dec/inf"
+)
+
+// QuantityProto is a struct that is equivalent to Quantity, but intended for
+// protobuf marshalling/unmarshalling. It is generated into a serialization
+// that matches Quantity. Do not use in Go structs.
+//
+// +protobuf=true
+type QuantityProto struct {
+	// The format of the quantity
+	Format Format
+	// The scale dimension of the value
+	Scale int32
+	// Bigint is serialized as a raw bytes array
+	Bigint []byte
+}
+
+// ProtoTime returns the Time as a new ProtoTime value.
+func (q *Quantity) QuantityProto() *QuantityProto {
+	if q == nil {
+		return &QuantityProto{}
+	}
+	p := &QuantityProto{
+		Format: q.Format,
+	}
+	if q.Amount != nil {
+		p.Scale = int32(q.Amount.Scale())
+		p.Bigint = q.Amount.UnscaledBig().Bytes()
+	}
+	return p
+}
+
+// Size implements the protobuf marshalling interface.
+func (q *Quantity) Size() (n int) { return q.QuantityProto().Size() }
+
+// Reset implements the protobuf marshalling interface.
+func (q *Quantity) Unmarshal(data []byte) error {
+	p := QuantityProto{}
+	if err := p.Unmarshal(data); err != nil {
+		return err
+	}
+	q.Format = p.Format
+	b := big.NewInt(0)
+	b.SetBytes(p.Bigint)
+	q.Amount = inf.NewDecBig(b, inf.Scale(p.Scale))
+	return nil
+}
+
+// Marshal implements the protobuf marshalling interface.
+func (q *Quantity) Marshal() (data []byte, err error) {
+	return q.QuantityProto().Marshal()
+}
+
+// MarshalTo implements the protobuf marshalling interface.
+func (q *Quantity) MarshalTo(data []byte) (int, error) {
+	return q.QuantityProto().MarshalTo(data)
+}

pkg/api/serialization_proto_test.go

@@ -0,0 +1,95 @@
+// +build proto
+
+/*
+Copyright 2015 The Kubernetes Authors All rights reserved.
+
+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
+
+    http://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.
+*/
+
+package api_test
+
+import (
+	"encoding/hex"
+	"math/rand"
+	"testing"
+
+	"github.com/gogo/protobuf/proto"
+	"k8s.io/kubernetes/pkg/api"
+	apitesting "k8s.io/kubernetes/pkg/api/testing"
+	"k8s.io/kubernetes/pkg/api/v1"
+	_ "k8s.io/kubernetes/pkg/apis/extensions"
+	_ "k8s.io/kubernetes/pkg/apis/extensions/v1beta1"
+	"k8s.io/kubernetes/pkg/runtime"
+	"k8s.io/kubernetes/pkg/runtime/protobuf"
+	"k8s.io/kubernetes/pkg/util"
+)
+
+func init() {
+	codecsToTest = append(codecsToTest, func(version string, item runtime.Object) (runtime.Codec, error) {
+		return protobuf.NewCodec(version, api.Scheme, api.Scheme, api.Scheme), nil
+	})
+}
+
+func TestProtobufRoundTrip(t *testing.T) {
+	obj := &v1.Pod{}
+	apitesting.FuzzerFor(t, "v1", rand.NewSource(benchmarkSeed)).Fuzz(obj)
+	data, err := obj.Marshal()
+	if err != nil {
+		t.Fatal(err)
+	}
+	out := &v1.Pod{}
+	if err := out.Unmarshal(data); err != nil {
+		t.Fatal(err)
+	}
+	if !api.Semantic.Equalities.DeepEqual(out, obj) {
+		t.Logf("marshal\n%s", hex.Dump(data))
+		t.Fatalf("Unmarshal is unequal\n%s", util.ObjectGoPrintSideBySide(out, obj))
+	}
+}
+
+func BenchmarkEncodeProtobufGeneratedMarshal(b *testing.B) {
+	items := benchmarkItems()
+	width := len(items)
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		if _, err := items[i%width].Marshal(); err != nil {
+			b.Fatal(err)
+		}
+	}
+	b.StopTimer()
+}
+
+// BenchmarkDecodeJSON provides a baseline for regular JSON decode performance
+func BenchmarkDecodeIntoProtobuf(b *testing.B) {
+	items := benchmarkItems()
+	width := len(items)
+	encoded := make([][]byte, width)
+	for i := range items {
+		data, err := (&items[i]).Marshal()
+		if err != nil {
+			b.Fatal(err)
+		}
+		encoded[i] = data
+		validate := &v1.Pod{}
+		if err := proto.Unmarshal(data, validate); err != nil {
+			b.Fatalf("Failed to unmarshal %d: %v\n%#v", i, err, items[i])
+		}
+	}
+
+	for i := 0; i < b.N; i++ {
+		obj := v1.Pod{}
+		if err := proto.Unmarshal(encoded[i%width], &obj); err != nil {
+			b.Fatal(err)
+		}
+	}
+}