-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
bench_test.go
582 lines (527 loc) · 15.4 KB
/
bench_test.go
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
// Copyright 2018 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package bench
import (
"bytes"
"context"
"fmt"
"testing"
"github.com/cockroachdb/cockroach/pkg/base"
"github.com/cockroachdb/cockroach/pkg/security"
"github.com/cockroachdb/cockroach/pkg/security/securitytest"
"github.com/cockroachdb/cockroach/pkg/server"
"github.com/cockroachdb/cockroach/pkg/settings/cluster"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/schemaexpr"
"github.com/cockroachdb/cockroach/pkg/sql/opt/exec"
"github.com/cockroachdb/cockroach/pkg/sql/opt/exec/execbuilder"
"github.com/cockroachdb/cockroach/pkg/sql/opt/memo"
"github.com/cockroachdb/cockroach/pkg/sql/opt/optbuilder"
"github.com/cockroachdb/cockroach/pkg/sql/opt/testutils/testcat"
"github.com/cockroachdb/cockroach/pkg/sql/opt/xform"
"github.com/cockroachdb/cockroach/pkg/sql/parser"
"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
"github.com/cockroachdb/cockroach/pkg/testutils/serverutils"
"github.com/cockroachdb/cockroach/pkg/testutils/sqlutils"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/randutil"
)
// A query can be issued using the "simple protocol" or the "prepare protocol".
//
// With the simple protocol, all arguments are inlined in the SQL string; the
// query goes through all phases of planning on each execution. Only these
// phases are valid with the simple protocol:
// - Parse
// - OptBuildNoNorm
// - OptBuildNorm
// - Explore
// - ExecBuild
//
// With the prepare protocol, the query is built at prepare time (with
// normalization rules turned on) and the resulting memo is saved and reused. On
// each execution, placeholders are assigned before exploration. Only these
// phases are valid with the prepare protocol:
// - AssignPlaceholdersNoNorm
// - AssignPlaceholdersNorm
// - Explore
// - ExecBuild
type Phase int
const (
// Parse creates the AST from the SQL string.
Parse Phase = iota
// OptBuildNoNorm constructs the Memo from the AST, with normalization rules
// disabled. OptBuildNoNorm includes the time to Parse.
OptBuildNoNorm
// OptBuildNorm constructs the Memo from the AST, with normalization rules
// enabled. OptBuildNorm includes the time to Parse.
OptBuildNorm
// AssignPlaceholdersNoNorm uses a prepared Memo and assigns placeholders,
// with normalization rules disabled.
AssignPlaceholdersNoNorm
// AssignPlaceholdersNorm uses a prepared Memo and assigns placeholders, with
// normalization rules enabled.
AssignPlaceholdersNorm
// Explore constructs the Memo (either by building it from the statement or by
// assigning placeholders to a prepared Memo) and enables all normalization
// and exploration rules. The Memo is fully optimized. Explore includes the
// time to OptBuildNorm or AssignPlaceholdersNorm.
Explore
// ExecBuild calls a stub factory to construct a dummy plan from the optimized
// Memo. Since the factory is not creating a real plan, only a part of the
// execbuild time is captured. ExecBuild includes the time to Explore.
ExecBuild
)
// SimplePhases are the legal phases when running a query that was not prepared.
var SimplePhases = []Phase{Parse, OptBuildNoNorm, OptBuildNorm, Explore, ExecBuild}
// PreparedPhases are the legal phases when running a query that was prepared.
var PreparedPhases = []Phase{AssignPlaceholdersNoNorm, AssignPlaceholdersNorm, Explore, ExecBuild}
func (bt Phase) String() string {
var strTab = [...]string{
Parse: "Parse",
OptBuildNoNorm: "OptBuildNoNorm",
OptBuildNorm: "OptBuildNorm",
AssignPlaceholdersNoNorm: "AssignPlaceholdersNoNorm",
AssignPlaceholdersNorm: "AssignPlaceholdersNorm",
Explore: "Explore",
ExecBuild: "ExecBuild",
}
return strTab[bt]
}
type benchQuery struct {
name string
query string
args []interface{}
}
var schemas = [...]string{
`CREATE TABLE kv (k BIGINT NOT NULL PRIMARY KEY, v BYTES NOT NULL)`,
`
CREATE TABLE customer
(
c_id integer not null,
c_d_id integer not null,
c_w_id integer not null,
c_first varchar(16),
c_middle char(2),
c_last varchar(16),
c_street_1 varchar(20),
c_street_2 varchar(20),
c_city varchar(20),
c_state char(2),
c_zip char(9),
c_phone char(16),
c_since timestamp,
c_credit char(2),
c_credit_lim decimal(12,2),
c_discount decimal(4,4),
c_balance decimal(12,2),
c_ytd_payment decimal(12,2),
c_payment_cnt integer,
c_delivery_cnt integer,
c_data varchar(500),
primary key (c_w_id, c_d_id, c_id),
index customer_idx (c_w_id, c_d_id, c_last, c_first)
)
`,
`
CREATE TABLE new_order
(
no_o_id integer not null,
no_d_id integer not null,
no_w_id integer not null,
primary key (no_w_id, no_d_id, no_o_id DESC)
)
`,
`
CREATE TABLE stock
(
s_i_id integer not null,
s_w_id integer not null,
s_quantity integer,
s_dist_01 char(24),
s_dist_02 char(24),
s_dist_03 char(24),
s_dist_04 char(24),
s_dist_05 char(24),
s_dist_06 char(24),
s_dist_07 char(24),
s_dist_08 char(24),
s_dist_09 char(24),
s_dist_10 char(24),
s_ytd integer,
s_order_cnt integer,
s_remote_cnt integer,
s_data varchar(50),
primary key (s_w_id, s_i_id)
)
`,
`
CREATE TABLE order_line
(
ol_o_id integer not null,
ol_d_id integer not null,
ol_w_id integer not null,
ol_number integer not null,
ol_i_id integer not null,
ol_supply_w_id integer,
ol_delivery_d timestamp,
ol_quantity integer,
ol_amount decimal(6,2),
ol_dist_info char(24),
primary key (ol_w_id, ol_d_id, ol_o_id DESC, ol_number),
index order_line_fk (ol_supply_w_id, ol_i_id),
foreign key (ol_supply_w_id, ol_i_id) references stock (s_w_id, s_i_id)
)
`,
`
CREATE TABLE j
(
a INT PRIMARY KEY,
b INT,
INDEX (b)
)
`,
}
var queries = [...]benchQuery{
// 1. Table with small number of columns.
// 2. Table with no indexes.
// 3. Very simple query that returns single row based on key filter.
{
name: "kv-read",
query: `SELECT k, v FROM kv WHERE k IN ($1)`,
args: []interface{}{1},
},
// 1. PREPARE with constant filter value (no placeholders).
{
name: "kv-read-const",
query: `SELECT k, v FROM kv WHERE k IN (1)`,
args: []interface{}{},
},
// 1. Table with many columns.
// 2. Multi-column primary key.
// 3. Mutiple indexes to consider.
// 4. Multiple placeholder values.
{
name: "tpcc-new-order",
query: `
SELECT c_discount, c_last, c_credit
FROM customer
WHERE c_w_id = $1 AND c_d_id = $2 AND c_id = $3
`,
args: []interface{}{10, 100, 50},
},
// 1. ORDER BY clause.
// 2. LIMIT clause.
// 3. Best plan requires reverse scan.
{
name: "tpcc-delivery",
query: `
SELECT no_o_id
FROM new_order
WHERE no_w_id = $1 AND no_d_id = $2
ORDER BY no_o_id ASC
LIMIT 1
`,
args: []interface{}{10, 100},
},
// 1. Count and Distinct aggregate functions.
// 2. Simple join.
// 3. Best plan requires lookup join.
// 4. Placeholders used in larger constant expressions.
{
name: "tpcc-stock-level",
query: `
SELECT count(DISTINCT s_i_id)
FROM order_line
JOIN stock
ON s_i_id=ol_i_id AND s_w_id=ol_w_id
WHERE ol_w_id = $1
AND ol_d_id = $2
AND ol_o_id BETWEEN $3 - 20 AND $3 - 1
AND s_quantity < $4
`,
args: []interface{}{10, 100, 1000, 15},
},
}
func init() {
security.SetAssetLoader(securitytest.EmbeddedAssets)
randutil.SeedForTests()
serverutils.InitTestServerFactory(server.TestServerFactory)
}
// BenchmarkPhases measures the time that each of the optimization phases takes
// to run. See the comments for the Phase enumeration for more details
// on what each phase includes.
func BenchmarkPhases(b *testing.B) {
for _, query := range queries {
h := newHarness(b, query)
b.Run(query.name, func(b *testing.B) {
b.Run("Simple", func(b *testing.B) {
for _, phase := range SimplePhases {
b.Run(phase.String(), func(b *testing.B) {
for i := 0; i < b.N; i++ {
h.runSimple(b, query, phase)
}
})
}
})
b.Run("Prepared", func(b *testing.B) {
phases := PreparedPhases
if h.prepMemo.IsOptimized() {
// If the query has no placeholders or the placeholder fast path
// succeeded, the only phase which does something is ExecBuild.
phases = []Phase{ExecBuild}
}
for _, phase := range phases {
b.Run(phase.String(), func(b *testing.B) {
for i := 0; i < b.N; i++ {
h.runPrepared(b, phase)
}
})
}
})
})
}
}
type harness struct {
ctx context.Context
semaCtx tree.SemaContext
evalCtx tree.EvalContext
prepMemo *memo.Memo
testCat *testcat.Catalog
optimizer xform.Optimizer
}
func newHarness(tb testing.TB, query benchQuery) *harness {
h := &harness{
ctx: context.Background(),
semaCtx: tree.MakeSemaContext(),
evalCtx: tree.MakeTestingEvalContext(cluster.MakeTestingClusterSettings()),
}
// Set up the test catalog.
h.testCat = testcat.New()
for _, schema := range schemas {
_, err := h.testCat.ExecuteDDL(schema)
if err != nil {
tb.Fatalf("%v", err)
}
}
if err := h.semaCtx.Placeholders.Init(len(query.args), nil /* typeHints */); err != nil {
tb.Fatal(err)
}
// Run optbuilder to build the memo for Prepare. Even if we will not be using
// the Prepare method, we still want to run the optbuilder to infer any
// placeholder types.
stmt, err := parser.ParseOne(query.query)
if err != nil {
tb.Fatalf("%v", err)
}
h.optimizer.Init(&h.evalCtx, h.testCat)
bld := optbuilder.New(h.ctx, &h.semaCtx, &h.evalCtx, h.testCat, h.optimizer.Factory(), stmt.AST)
bld.KeepPlaceholders = true
if err := bld.Build(); err != nil {
tb.Fatalf("%v", err)
}
// If there are no placeholders, we explore during PREPARE.
if len(query.args) == 0 {
if _, err := h.optimizer.Optimize(); err != nil {
tb.Fatalf("%v", err)
}
} else {
if _, _, err := h.optimizer.TryPlaceholderFastPath(); err != nil {
tb.Fatalf("%v", err)
}
}
h.prepMemo = h.optimizer.DetachMemo()
h.optimizer = xform.Optimizer{}
// Construct placeholder values.
h.semaCtx.Placeholders.Values = make(tree.QueryArguments, len(query.args))
for i, arg := range query.args {
var parg tree.Expr
parg, err := parser.ParseExpr(fmt.Sprintf("%v", arg))
if err != nil {
tb.Fatalf("%v", err)
}
id := tree.PlaceholderIdx(i)
typ, _ := h.semaCtx.Placeholders.ValueType(id)
texpr, err := schemaexpr.SanitizeVarFreeExpr(
context.Background(),
parg,
typ,
"", /* context */
&h.semaCtx,
tree.VolatilityVolatile,
)
if err != nil {
tb.Fatalf("%v", err)
}
h.semaCtx.Placeholders.Values[i] = texpr
}
h.evalCtx.Placeholders = &h.semaCtx.Placeholders
h.evalCtx.Annotations = &h.semaCtx.Annotations
return h
}
// runSimple simulates running a query through the "simple protocol" (no prepare
// step). The placeholders are replaced with their values automatically when we
// build the memo.
func (h *harness) runSimple(tb testing.TB, query benchQuery, phase Phase) {
stmt, err := parser.ParseOne(query.query)
if err != nil {
tb.Fatalf("%v", err)
}
if phase == Parse {
return
}
h.optimizer.Init(&h.evalCtx, h.testCat)
if phase == OptBuildNoNorm {
h.optimizer.DisableOptimizations()
}
bld := optbuilder.New(h.ctx, &h.semaCtx, &h.evalCtx, h.testCat, h.optimizer.Factory(), stmt.AST)
// Note that KeepPlaceholders is false and we have placeholder values in the
// evalCtx, so the optbuilder will replace all placeholders with their values.
if err = bld.Build(); err != nil {
tb.Fatalf("%v", err)
}
if phase == OptBuildNoNorm || phase == OptBuildNorm {
return
}
if _, err := h.optimizer.Optimize(); err != nil {
panic(err)
}
execMemo := h.optimizer.Memo()
if phase == Explore {
return
}
if phase != ExecBuild {
tb.Fatalf("invalid phase %s for Simple", phase)
}
root := execMemo.RootExpr()
eb := execbuilder.New(
exec.StubFactory{}, execMemo, nil /* catalog */, root, &h.evalCtx, true, /* allowAutoCommit */
)
if _, err = eb.Build(); err != nil {
tb.Fatalf("%v", err)
}
}
// runPrepared simulates running the query after it was prepared.
func (h *harness) runPrepared(tb testing.TB, phase Phase) {
h.optimizer.Init(&h.evalCtx, h.testCat)
if !h.prepMemo.IsOptimized() {
if phase == AssignPlaceholdersNoNorm {
h.optimizer.DisableOptimizations()
}
err := h.optimizer.Factory().AssignPlaceholders(h.prepMemo)
if err != nil {
tb.Fatalf("%v", err)
}
}
if phase == AssignPlaceholdersNoNorm || phase == AssignPlaceholdersNorm {
return
}
var execMemo *memo.Memo
if h.prepMemo.IsOptimized() {
// No placeholders, we already did the exploration at prepare time.
execMemo = h.prepMemo
} else {
if _, err := h.optimizer.Optimize(); err != nil {
tb.Fatalf("%v", err)
}
execMemo = h.optimizer.Memo()
}
if phase == Explore {
return
}
if phase != ExecBuild {
tb.Fatalf("invalid phase %s for Prepared", phase)
}
root := execMemo.RootExpr()
eb := execbuilder.New(
exec.StubFactory{}, execMemo, nil /* catalog */, root, &h.evalCtx, true, /* allowAutoCommit */
)
if _, err := eb.Build(); err != nil {
tb.Fatalf("%v", err)
}
}
func makeChain(size int) benchQuery {
var buf bytes.Buffer
buf.WriteString(`SELECT * FROM `)
comma := ""
for i := 0; i < size; i++ {
buf.WriteString(comma)
fmt.Fprintf(&buf, "j AS tab%d", i+1)
comma = ", "
}
if size > 1 {
buf.WriteString(" WHERE ")
}
comma = ""
for i := 0; i < size-1; i++ {
buf.WriteString(comma)
fmt.Fprintf(&buf, "tab%d.a = tab%d.b", i+1, i+2)
comma = " AND "
}
return benchQuery{
name: fmt.Sprintf("chain-%d", size),
query: buf.String(),
}
}
// BenchmarkChain benchmarks the planning of a "chain" query, where
// some number of tables are joined together, with there being a
// predicate joining the first and second, second and third, third
// and fourth, etc.
//
// For example, a 5-chain looks like:
//
// SELECT * FROM a, b, c, d, e
// WHERE a.x = b.y
// AND b.x = c.y
// AND c.x = d.y
// AND d.x = e.y
//
func BenchmarkChain(b *testing.B) {
for i := 1; i < 20; i++ {
q := makeChain(i)
h := newHarness(b, q)
b.Run(q.name, func(b *testing.B) {
for i := 0; i < b.N; i++ {
h.runSimple(b, q, Explore)
}
})
}
}
// BenchmarkEndToEnd measures the time to execute a query end-to-end (against a
// test server).
func BenchmarkEndToEnd(b *testing.B) {
defer log.Scope(b).Close(b)
// Set up database.
srv, db, _ := serverutils.StartServer(b, base.TestServerArgs{UseDatabase: "bench"})
defer srv.Stopper().Stop(context.Background())
sr := sqlutils.MakeSQLRunner(db)
sr.Exec(b, `CREATE DATABASE bench`)
for _, schema := range schemas {
sr.Exec(b, schema)
}
for _, query := range queries {
b.Run(query.name, func(b *testing.B) {
b.Run("Simple", func(b *testing.B) {
for i := 0; i < b.N; i++ {
sr.Exec(b, query.query, query.args...)
}
})
b.Run("Prepared", func(b *testing.B) {
prepared, err := db.Prepare(query.query)
if err != nil {
b.Fatalf("%v", err)
}
for i := 0; i < b.N; i++ {
if _, err = prepared.Exec(query.args...); err != nil {
b.Fatalf("%v", err)
}
}
})
})
}
}