forked from couchbase/indexing
-
Notifications
You must be signed in to change notification settings - Fork 0
/
scan_pipeline.go
483 lines (414 loc) · 10.9 KB
/
scan_pipeline.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
// Copyright (c) 2014 Couchbase, Inc.
// 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 indexer
import (
"bytes"
"errors"
"github.com/couchbase/indexing/secondary/collatejson"
c "github.com/couchbase/indexing/secondary/common"
p "github.com/couchbase/indexing/secondary/pipeline"
)
var (
ErrLimitReached = errors.New("Row limit reached")
)
type ScanPipeline struct {
src p.Source
object p.Pipeline
req *ScanRequest
rowsReturned uint64
bytesRead uint64
}
func (p *ScanPipeline) Cancel(err error) {
p.src.Shutdown(err)
}
func (p *ScanPipeline) Execute() error {
return p.object.Execute()
}
func (p ScanPipeline) RowsReturned() uint64 {
return p.rowsReturned
}
func (p ScanPipeline) BytesRead() uint64 {
return p.bytesRead
}
func NewScanPipeline(req *ScanRequest, w ScanResponseWriter, is IndexSnapshot) *ScanPipeline {
scanPipeline := new(ScanPipeline)
scanPipeline.req = req
src := &IndexScanSource{is: is, p: scanPipeline}
src.InitWriter()
dec := &IndexScanDecoder{p: scanPipeline}
dec.InitReadWriter()
wr := &IndexScanWriter{w: w, p: scanPipeline}
wr.InitReader()
dec.SetSource(src)
wr.SetSource(dec)
scanPipeline.src = src
scanPipeline.object.AddSource("source", src)
scanPipeline.object.AddFilter("decoder", dec)
scanPipeline.object.AddSink("writer", wr)
return scanPipeline
}
type IndexScanSource struct {
p.ItemWriter
is IndexSnapshot
p *ScanPipeline
}
type IndexScanDecoder struct {
p.ItemReadWriter
p *ScanPipeline
}
type IndexScanWriter struct {
p.ItemReader
w ScanResponseWriter
p *ScanPipeline
}
func (s *IndexScanSource) Routine() error {
var err error
defer s.CloseWrite()
r := s.p.req
var currentScan Scan
currOffset := int64(0)
count := 1
checkDistinct := r.Distinct && !r.isPrimary
buf := secKeyBufPool.Get()
r.keyBufList = append(r.keyBufList, buf)
buf2 := secKeyBufPool.Get()
r.keyBufList = append(r.keyBufList, buf2)
previousRow := (*buf2)[:0]
revbuf := secKeyBufPool.Get()
r.keyBufList = append(r.keyBufList, revbuf)
iterCount := 0
fn := func(entry []byte) error {
if iterCount%SCAN_ROLLBACK_ERROR_BATCHSIZE == 0 && r.hasRollback != nil && r.hasRollback.Load() == true {
return ErrIndexRollback
}
iterCount++
skipRow := false
var ck [][]byte
//get the key in original format
if s.p.req.IndexInst.Defn.Desc != nil {
revbuf := (*revbuf)[:0]
//copy is required, otherwise storage may get updated if storage
//returns pointer to original item(e.g. memdb)
revbuf = append(revbuf, entry...)
jsonEncoder.ReverseCollate(revbuf, s.p.req.IndexInst.Defn.Desc)
entry = revbuf
}
if currentScan.ScanType == FilterRangeReq {
if len(entry) > cap(*buf) {
*buf = make([]byte, 0, len(entry)+1024)
}
skipRow, ck, err = filterScanRow(entry, currentScan, (*buf)[:0])
if err != nil {
return err
}
}
if skipRow {
return nil
}
if !r.isPrimary && r.Indexprojection != nil && r.Indexprojection.projectSecKeys {
if ck == nil && len(entry) > cap(*buf) {
*buf = make([]byte, 0, len(entry)+1024)
}
entry, err = projectKeys(ck, entry, (*buf)[:0], r.Indexprojection)
if err != nil {
return err
}
}
if checkDistinct {
if len(previousRow) != 0 && distinctCompare(entry, previousRow) {
return nil // Ignore the entry as it is same as previous entry
}
}
if !r.isPrimary {
e := secondaryIndexEntry(entry)
count = e.Count()
}
for i := 0; i < count; i++ {
if r.Distinct && i > 0 {
break
}
if currOffset >= r.Offset {
s.p.rowsReturned++
wrErr := s.WriteItem(entry)
if wrErr != nil {
return wrErr
}
if s.p.rowsReturned == uint64(r.Limit) {
return ErrLimitReached
}
} else {
currOffset++
}
}
if checkDistinct {
previousRow = append(previousRow[:0], entry...)
}
return nil
}
sliceSnapshots := GetSliceSnapshots(s.is)
loop:
for _, scan := range r.Scans {
currentScan = scan
for _, snap := range sliceSnapshots {
if scan.ScanType == AllReq {
err = snap.Snapshot().All(r.Ctx, fn)
} else if scan.ScanType == LookupReq {
err = snap.Snapshot().Lookup(r.Ctx, scan.Equals, fn)
} else if scan.ScanType == RangeReq || scan.ScanType == FilterRangeReq {
err = snap.Snapshot().Range(r.Ctx, scan.Low, scan.High, scan.Incl, fn)
}
switch err {
case nil:
case p.ErrSupervisorKill, ErrLimitReached:
break loop
default:
s.CloseWithError(err)
break loop
}
}
}
return nil
}
func (d *IndexScanDecoder) Routine() error {
defer d.CloseWrite()
defer d.CloseRead()
var sk, docid []byte
tmpBuf := p.GetBlock()
defer p.PutBlock(tmpBuf)
loop:
for {
row, err := d.ReadItem()
switch err {
case nil:
case p.ErrNoMoreItem, p.ErrSupervisorKill:
break loop
default:
d.CloseWithError(err)
break loop
}
if len(row)*3 > cap(*tmpBuf) {
(*tmpBuf) = make([]byte, len(row)*3, len(row)*3)
}
t := (*tmpBuf)[:0]
if d.p.req.isPrimary {
sk, docid = piSplitEntry(row, t)
} else {
sk, docid, _ = siSplitEntry(row, t)
}
d.p.bytesRead += uint64(len(sk) + len(docid))
if !d.p.req.isPrimary && !d.p.req.projectPrimaryKey {
docid = nil
}
err = d.WriteItem(sk, docid)
if err != nil {
break // TODO: Old code. Should it be ClosedWithError?
}
}
return nil
}
func (d *IndexScanWriter) Routine() error {
var err error
var sk, pk []byte
defer func() {
// Send error to the client if not client requested cancel.
if err != nil && err.Error() != c.ErrClientCancel.Error() {
d.w.Error(err)
}
d.CloseRead()
}()
loop:
for {
sk, err = d.ReadItem()
switch err {
case nil:
case p.ErrNoMoreItem:
err = nil
break loop
default:
break loop
}
pk, err = d.ReadItem()
if err != nil {
return err
}
if err = d.w.Row(pk, sk); err != nil {
return err
}
/*
TODO(sarath): Use block chunk send protocol
Instead of collecting rows and encoding into protobuf,
we can send full 16kb block.
b, err := d.PeekBlock()
if err == p.ErrNoMoreItem {
d.CloseRead()
return nil
}
d.W.RawBytes(b)
d.FlushBlock()
*/
}
return err
}
func piSplitEntry(entry []byte, tmp []byte) ([]byte, []byte) {
e := primaryIndexEntry(entry)
sk, err := e.ReadSecKey(tmp)
c.CrashOnError(err)
docid, err := e.ReadDocId(sk)
return sk, docid[len(sk):]
}
func siSplitEntry(entry []byte, tmp []byte) ([]byte, []byte, int) {
e := secondaryIndexEntry(entry)
sk, err := e.ReadSecKey(tmp)
c.CrashOnError(err)
docid, err := e.ReadDocId(sk)
c.CrashOnError(err)
count := e.Count()
return sk, docid[len(sk):], count
}
// Return true if the row needs to be skipped based on the filter
func filterScanRow(key []byte, scan Scan, buf []byte) (bool, [][]byte, error) {
codec := collatejson.NewCodec(16)
compositekeys, err := codec.ExplodeArray(key, buf)
if err != nil {
return false, nil, err
}
var filtermatch bool
for _, filtercollection := range scan.Filters {
if len(filtercollection.CompositeFilters) > len(compositekeys) {
// There cannot be more ranges than number of composite keys
err = errors.New("There are more ranges than number of composite elements in the index")
return false, nil, err
}
filtermatch = applyFilter(compositekeys, filtercollection.CompositeFilters)
if filtermatch {
return false, compositekeys, nil
}
}
return true, compositekeys, nil
}
// Return true if filter matches the composite keys
func applyFilter(compositekeys [][]byte, compositefilters []CompositeElementFilter) bool {
for i, filter := range compositefilters {
ck := compositekeys[i]
checkLow := (filter.Low != MinIndexKey)
checkHigh := (filter.High != MaxIndexKey)
switch filter.Inclusion {
case Neither:
// if ck > low and ck < high
if checkLow {
if !(bytes.Compare(ck, filter.Low.Bytes()) > 0) {
return false
}
}
if checkHigh {
if !(bytes.Compare(ck, filter.High.Bytes()) < 0) {
return false
}
}
case Low:
// if ck >= low and ck < high
if checkLow {
if !(bytes.Compare(ck, filter.Low.Bytes()) >= 0) {
return false
}
}
if checkHigh {
if !(bytes.Compare(ck, filter.High.Bytes()) < 0) {
return false
}
}
case High:
// if ck > low and ck <= high
if checkLow {
if !(bytes.Compare(ck, filter.Low.Bytes()) > 0) {
return false
}
}
if checkHigh {
if !(bytes.Compare(ck, filter.High.Bytes()) <= 0) {
return false
}
}
case Both:
// if ck >= low and ck <= high
if checkLow {
if !(bytes.Compare(ck, filter.Low.Bytes()) >= 0) {
return false
}
}
if checkHigh {
if !(bytes.Compare(ck, filter.High.Bytes()) <= 0) {
return false
}
}
}
}
return true
}
// Compare secondary entries and return true
// if the secondary keys of entries are equal
func distinctCompare(entryBytes1, entryBytes2 []byte) bool {
entry1 := secondaryIndexEntry(entryBytes1)
entry2 := secondaryIndexEntry(entryBytes2)
if bytes.Compare(entryBytes1[:entry1.lenKey()], entryBytes2[:entry2.lenKey()]) == 0 {
return true
}
return false
}
func projectKeys(compositekeys [][]byte, key, buf []byte, projection *Projection) ([]byte, error) {
var err error
if projection.entryKeysEmpty {
entry := secondaryIndexEntry(key)
buf = append(buf, key[entry.lenKey():]...)
return buf, nil
}
codec := collatejson.NewCodec(16)
if compositekeys == nil {
compositekeys, err = codec.ExplodeArray(key, buf)
if err != nil {
return nil, err
}
}
var keysToJoin [][]byte
for i, projectKey := range projection.projectionKeys {
if projectKey {
keysToJoin = append(keysToJoin, compositekeys[i])
}
}
// Note: Reusing the same buf used for Explode in JoinArray as well
// This is because we always project in order and hence avoiding two
// different buffers for Explode and Join
if buf, err = codec.JoinArray(keysToJoin, buf); err != nil {
return nil, err
}
entry := secondaryIndexEntry(key)
buf = append(buf, key[entry.lenKey():]...)
return buf, nil
}
func projectLeadingKey(compositekeys [][]byte, key []byte, buf *[]byte) ([]byte, error) {
var err error
codec := collatejson.NewCodec(16)
if compositekeys == nil {
if len(key) > cap(*buf) {
*buf = make([]byte, 0, len(key)+RESIZE_PAD)
}
compositekeys, err = codec.ExplodeArray(key, (*buf)[:0])
if err != nil {
return nil, err
}
}
var keysToJoin [][]byte
keysToJoin = append(keysToJoin, compositekeys[0])
if *buf, err = codec.JoinArray(keysToJoin, (*buf)[:0]); err != nil {
return nil, err
}
entry := secondaryIndexEntry(key)
*buf = append(*buf, key[entry.lenKey():]...)
return *buf, nil
}