summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/hashicorp/go-msgpack/codec/bench_test.go
blob: 4d437035e0fafc06a713c2cef75e2b3b4315b4e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
// Copyright (c) 2012, 2013 Ugorji Nwoke. All rights reserved.
// Use of this source code is governed by a BSD-style license found in the LICENSE file.

package codec

import (
	"bytes"
	"encoding/gob"
	"encoding/json"
	"flag"
	"fmt"
	"reflect"
	"runtime"
	"testing"
	"time"
)

// Sample way to run:
// go test -bi -bv -bd=1 -benchmem -bench=.

var (
	_       = fmt.Printf
	benchTs *TestStruc

	approxSize int

	benchDoInitBench     bool
	benchVerify          bool
	benchUnscientificRes bool = false
	//depth of 0 maps to ~400bytes json-encoded string, 1 maps to ~1400 bytes, etc
	//For depth>1, we likely trigger stack growth for encoders, making benchmarking unreliable.
	benchDepth     int
	benchInitDebug bool
	benchCheckers  []benchChecker
)

type benchEncFn func(interface{}) ([]byte, error)
type benchDecFn func([]byte, interface{}) error
type benchIntfFn func() interface{}

type benchChecker struct {
	name     string
	encodefn benchEncFn
	decodefn benchDecFn
}

func benchInitFlags() {
	flag.BoolVar(&benchInitDebug, "bg", false, "Bench Debug")
	flag.IntVar(&benchDepth, "bd", 1, "Bench Depth: If >1, potential unreliable results due to stack growth")
	flag.BoolVar(&benchDoInitBench, "bi", false, "Run Bench Init")
	flag.BoolVar(&benchVerify, "bv", false, "Verify Decoded Value during Benchmark")
	flag.BoolVar(&benchUnscientificRes, "bu", false, "Show Unscientific Results during Benchmark")
}

func benchInit() {
	benchTs = newTestStruc(benchDepth, true)
	approxSize = approxDataSize(reflect.ValueOf(benchTs))
	bytesLen := 1024 * 4 * (benchDepth + 1) * (benchDepth + 1)
	if bytesLen < approxSize {
		bytesLen = approxSize
	}

	benchCheckers = append(benchCheckers,
		benchChecker{"msgpack", fnMsgpackEncodeFn, fnMsgpackDecodeFn},
		benchChecker{"binc-nosym", fnBincNoSymEncodeFn, fnBincNoSymDecodeFn},
		benchChecker{"binc-sym", fnBincSymEncodeFn, fnBincSymDecodeFn},
		benchChecker{"simple", fnSimpleEncodeFn, fnSimpleDecodeFn},
		benchChecker{"gob", fnGobEncodeFn, fnGobDecodeFn},
		benchChecker{"json", fnJsonEncodeFn, fnJsonDecodeFn},
	)
	if benchDoInitBench {
		runBenchInit()
	}
}

func runBenchInit() {
	logT(nil, "..............................................")
	logT(nil, "BENCHMARK INIT: %v", time.Now())
	logT(nil, "To run full benchmark comparing encodings (MsgPack, Binc, Simple, JSON, GOB, etc), "+
		"use: \"go test -bench=.\"")
	logT(nil, "Benchmark: ")
	logT(nil, "\tStruct recursive Depth:             %d", benchDepth)
	if approxSize > 0 {
		logT(nil, "\tApproxDeepSize Of benchmark Struct: %d bytes", approxSize)
	}
	if benchUnscientificRes {
		logT(nil, "Benchmark One-Pass Run (with Unscientific Encode/Decode times): ")
	} else {
		logT(nil, "Benchmark One-Pass Run:")
	}
	for _, bc := range benchCheckers {
		doBenchCheck(bc.name, bc.encodefn, bc.decodefn)
	}
	logT(nil, "..............................................")
	if benchInitDebug {
		logT(nil, "<<<<====>>>> depth: %v, ts: %#v\n", benchDepth, benchTs)
	}
}

func fnBenchNewTs() interface{} {
	return new(TestStruc)
}

func doBenchCheck(name string, encfn benchEncFn, decfn benchDecFn) {
	runtime.GC()
	tnow := time.Now()
	buf, err := encfn(benchTs)
	if err != nil {
		logT(nil, "\t%10s: **** Error encoding benchTs: %v", name, err)
	}
	encDur := time.Now().Sub(tnow)
	encLen := len(buf)
	runtime.GC()
	if !benchUnscientificRes {
		logT(nil, "\t%10s: len: %d bytes\n", name, encLen)
		return
	}
	tnow = time.Now()
	if err = decfn(buf, new(TestStruc)); err != nil {
		logT(nil, "\t%10s: **** Error decoding into new TestStruc: %v", name, err)
	}
	decDur := time.Now().Sub(tnow)
	logT(nil, "\t%10s: len: %d bytes, encode: %v, decode: %v\n", name, encLen, encDur, decDur)
}

func fnBenchmarkEncode(b *testing.B, encName string, ts interface{}, encfn benchEncFn) {
	runtime.GC()
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		_, err := encfn(ts)
		if err != nil {
			logT(b, "Error encoding benchTs: %s: %v", encName, err)
			b.FailNow()
		}
	}
}

func fnBenchmarkDecode(b *testing.B, encName string, ts interface{},
	encfn benchEncFn, decfn benchDecFn, newfn benchIntfFn,
) {
	buf, err := encfn(ts)
	if err != nil {
		logT(b, "Error encoding benchTs: %s: %v", encName, err)
		b.FailNow()
	}
	runtime.GC()
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		ts = newfn()
		if err = decfn(buf, ts); err != nil {
			logT(b, "Error decoding into new TestStruc: %s: %v", encName, err)
			b.FailNow()
		}
		if benchVerify {
			if vts, vok := ts.(*TestStruc); vok {
				verifyTsTree(b, vts)
			}
		}
	}
}

func verifyTsTree(b *testing.B, ts *TestStruc) {
	var ts0, ts1m, ts2m, ts1s, ts2s *TestStruc
	ts0 = ts

	if benchDepth > 0 {
		ts1m, ts1s = verifyCheckAndGet(b, ts0)
	}

	if benchDepth > 1 {
		ts2m, ts2s = verifyCheckAndGet(b, ts1m)
	}
	for _, tsx := range []*TestStruc{ts0, ts1m, ts2m, ts1s, ts2s} {
		if tsx != nil {
			verifyOneOne(b, tsx)
		}
	}
}

func verifyCheckAndGet(b *testing.B, ts0 *TestStruc) (ts1m *TestStruc, ts1s *TestStruc) {
	// if len(ts1m.Ms) <= 2 {
	// 	logT(b, "Error: ts1m.Ms len should be > 2. Got: %v", len(ts1m.Ms))
	// 	b.FailNow()
	// }
	if len(ts0.Its) == 0 {
		logT(b, "Error: ts0.Islice len should be > 0. Got: %v", len(ts0.Its))
		b.FailNow()
	}
	ts1m = ts0.Mtsptr["0"]
	ts1s = ts0.Its[0]
	if ts1m == nil || ts1s == nil {
		logT(b, "Error: At benchDepth 1, No *TestStruc found")
		b.FailNow()
	}
	return
}

func verifyOneOne(b *testing.B, ts *TestStruc) {
	if ts.I64slice[2] != int64(3) {
		logT(b, "Error: Decode failed by checking values")
		b.FailNow()
	}
}

func fnMsgpackEncodeFn(ts interface{}) (bs []byte, err error) {
	err = NewEncoderBytes(&bs, testMsgpackH).Encode(ts)
	return
}

func fnMsgpackDecodeFn(buf []byte, ts interface{}) error {
	return NewDecoderBytes(buf, testMsgpackH).Decode(ts)
}

func fnBincEncodeFn(ts interface{}, sym AsSymbolFlag) (bs []byte, err error) {
	tSym := testBincH.AsSymbols
	testBincH.AsSymbols = sym
	err = NewEncoderBytes(&bs, testBincH).Encode(ts)
	testBincH.AsSymbols = tSym
	return
}

func fnBincDecodeFn(buf []byte, ts interface{}, sym AsSymbolFlag) (err error) {
	tSym := testBincH.AsSymbols
	testBincH.AsSymbols = sym
	err = NewDecoderBytes(buf, testBincH).Decode(ts)
	testBincH.AsSymbols = tSym
	return
}

func fnBincNoSymEncodeFn(ts interface{}) (bs []byte, err error) {
	return fnBincEncodeFn(ts, AsSymbolNone)
}

func fnBincNoSymDecodeFn(buf []byte, ts interface{}) error {
	return fnBincDecodeFn(buf, ts, AsSymbolNone)
}

func fnBincSymEncodeFn(ts interface{}) (bs []byte, err error) {
	return fnBincEncodeFn(ts, AsSymbolAll)
}

func fnBincSymDecodeFn(buf []byte, ts interface{}) error {
	return fnBincDecodeFn(buf, ts, AsSymbolAll)
}

func fnSimpleEncodeFn(ts interface{}) (bs []byte, err error) {
	err = NewEncoderBytes(&bs, testSimpleH).Encode(ts)
	return
}

func fnSimpleDecodeFn(buf []byte, ts interface{}) error {
	return NewDecoderBytes(buf, testSimpleH).Decode(ts)
}

func fnGobEncodeFn(ts interface{}) ([]byte, error) {
	bbuf := new(bytes.Buffer)
	err := gob.NewEncoder(bbuf).Encode(ts)
	return bbuf.Bytes(), err
}

func fnGobDecodeFn(buf []byte, ts interface{}) error {
	return gob.NewDecoder(bytes.NewBuffer(buf)).Decode(ts)
}

func fnJsonEncodeFn(ts interface{}) ([]byte, error) {
	return json.Marshal(ts)
}

func fnJsonDecodeFn(buf []byte, ts interface{}) error {
	return json.Unmarshal(buf, ts)
}

func Benchmark__Msgpack____Encode(b *testing.B) {
	fnBenchmarkEncode(b, "msgpack", benchTs, fnMsgpackEncodeFn)
}

func Benchmark__Msgpack____Decode(b *testing.B) {
	fnBenchmarkDecode(b, "msgpack", benchTs, fnMsgpackEncodeFn, fnMsgpackDecodeFn, fnBenchNewTs)
}

func Benchmark__Binc_NoSym_Encode(b *testing.B) {
	fnBenchmarkEncode(b, "binc", benchTs, fnBincNoSymEncodeFn)
}

func Benchmark__Binc_NoSym_Decode(b *testing.B) {
	fnBenchmarkDecode(b, "binc", benchTs, fnBincNoSymEncodeFn, fnBincNoSymDecodeFn, fnBenchNewTs)
}

func Benchmark__Binc_Sym___Encode(b *testing.B) {
	fnBenchmarkEncode(b, "binc", benchTs, fnBincSymEncodeFn)
}

func Benchmark__Binc_Sym___Decode(b *testing.B) {
	fnBenchmarkDecode(b, "binc", benchTs, fnBincSymEncodeFn, fnBincSymDecodeFn, fnBenchNewTs)
}

func Benchmark__Simple____Encode(b *testing.B) {
	fnBenchmarkEncode(b, "simple", benchTs, fnSimpleEncodeFn)
}

func Benchmark__Simple____Decode(b *testing.B) {
	fnBenchmarkDecode(b, "simple", benchTs, fnSimpleEncodeFn, fnSimpleDecodeFn, fnBenchNewTs)
}

func Benchmark__Gob________Encode(b *testing.B) {
	fnBenchmarkEncode(b, "gob", benchTs, fnGobEncodeFn)
}

func Benchmark__Gob________Decode(b *testing.B) {
	fnBenchmarkDecode(b, "gob", benchTs, fnGobEncodeFn, fnGobDecodeFn, fnBenchNewTs)
}

func Benchmark__Json_______Encode(b *testing.B) {
	fnBenchmarkEncode(b, "json", benchTs, fnJsonEncodeFn)
}

func Benchmark__Json_______Decode(b *testing.B) {
	fnBenchmarkDecode(b, "json", benchTs, fnJsonEncodeFn, fnJsonDecodeFn, fnBenchNewTs)
}