aboutsummaryrefslogtreecommitdiffstats
path: root/core/bloombits/matcher.go
blob: f3ed405a6150cd52cb043b7b6a7325613036cfe0 (plain) (blame)
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package bloombits

import (
    "bytes"
    "errors"
    "math"
    "sort"
    "sync"
    "sync/atomic"
    "time"

    "github.com/ethereum/go-ethereum/common/bitutil"
    "github.com/ethereum/go-ethereum/crypto"
)

// bloomIndexes represents the bit indexes inside the bloom filter that belong
// to some key.
type bloomIndexes [3]uint

// calcBloomIndexes returns the bloom filter bit indexes belonging to the given key.
func calcBloomIndexes(b []byte) bloomIndexes {
    b = crypto.Keccak256(b)

    var idxs bloomIndexes
    for i := 0; i < len(idxs); i++ {
        idxs[i] = (uint(b[2*i])<<8)&2047 + uint(b[2*i+1])
    }
    return idxs
}

// partialMatches with a non-nil vector represents a section in which some sub-
// matchers have already found potential matches. Subsequent sub-matchers will
// binary AND their matches with this vector. If vector is nil, it represents a
// section to be processed by the first sub-matcher.
type partialMatches struct {
    section uint64
    bitset  []byte
}

// Retrieval represents a request for retrieval task assignments for a given
// bit with the given number of fetch elements, or a response for such a request.
// It can also have the actual results set to be used as a delivery data struct.
type Retrieval struct {
    Bit      uint
    Sections []uint64
    Bitsets  [][]byte
}

// Matcher is a pipelined system of schedulers and logic matchers which perform
// binary AND/OR operations on the bit-streams, creating a stream of potential
// blocks to inspect for data content.
type Matcher struct {
    sectionSize uint64 // Size of the data batches to filter on

    filters    [][]bloomIndexes    // Filter the system is matching for
    schedulers map[uint]*scheduler // Retrieval schedulers for loading bloom bits

    retrievers chan chan uint       // Retriever processes waiting for bit allocations
    counters   chan chan uint       // Retriever processes waiting for task count reports
    retrievals chan chan *Retrieval // Retriever processes waiting for task allocations
    deliveries chan *Retrieval      // Retriever processes waiting for task response deliveries

    running uint32 // Atomic flag whether a session is live or not
}

// NewMatcher creates a new pipeline for retrieving bloom bit streams and doing
// address and topic filtering on them.
func NewMatcher(sectionSize uint64, filters [][][]byte) *Matcher {
    // Create the matcher instance
    m := &Matcher{
        sectionSize: sectionSize,
        schedulers:  make(map[uint]*scheduler),
        retrievers:  make(chan chan uint),
        counters:    make(chan chan uint),
        retrievals:  make(chan chan *Retrieval),
        deliveries:  make(chan *Retrieval),
    }
    // Calculate the bloom bit indexes for the groups we're interested in
    m.filters = nil

    for _, filter := range filters {
        bloomBits := make([]bloomIndexes, len(filter))
        for i, clause := range filter {
            bloomBits[i] = calcBloomIndexes(clause)
        }
        m.filters = append(m.filters, bloomBits)
    }
    // For every bit, create a scheduler to load/download the bit vectors
    for _, bloomIndexLists := range m.filters {
        for _, bloomIndexList := range bloomIndexLists {
            for _, bloomIndex := range bloomIndexList {
                m.addScheduler(bloomIndex)
            }
        }
    }
    return m
}

// addScheduler adds a bit stream retrieval scheduler for the given bit index if
// it has not existed before. If the bit is already selected for filtering, the
// existing scheduler can be used.
func (m *Matcher) addScheduler(idx uint) {
    if _, ok := m.schedulers[idx]; ok {
        return
    }
    m.schedulers[idx] = newScheduler(idx)
}

// Start starts the matching process and returns a stream of bloom matches in
// a given range of blocks. If there are no more matches in the range, the result
// channel is closed.
func (m *Matcher) Start(begin, end uint64, results chan uint64) (*MatcherSession, error) {
    // Make sure we're not creating concurrent sessions
    if atomic.SwapUint32(&m.running, 1) == 1 {
        return nil, errors.New("matcher already running")
    }
    defer atomic.StoreUint32(&m.running, 0)

    // Initiate a new matching round
    session := &MatcherSession{
        matcher: m,
        quit:    make(chan struct{}),
        kill:    make(chan struct{}),
    }
    for _, scheduler := range m.schedulers {
        scheduler.reset()
    }
    sink := m.run(begin, end, cap(results), session)

    // Read the output from the result sink and deliver to the user
    session.pend.Add(1)
    go func() {
        defer session.pend.Done()
        defer close(results)

        for {
            select {
            case <-session.quit:
                return

            case res, ok := <-sink:
                // New match result found
                if !ok {
                    return
                }
                // Calculate the first and last blocks of the section
                sectionStart := res.section * m.sectionSize

                first := sectionStart
                if begin > first {
                    first = begin
                }
                last := sectionStart + m.sectionSize - 1
                if end < last {
                    last = end
                }
                // Iterate over all the blocks in the section and return the matching ones
                for i := first; i <= last; i++ {
                    // Skip the entire byte if no matches are found inside
                    next := res.bitset[(i-sectionStart)/8]
                    if next == 0 {
                        i += 7
                        continue
                    }
                    // Some bit it set, do the actual submatching
                    if bit := 7 - i%8; next&(1<<bit) != 0 {
                        select {
                        case <-session.quit:
                            return
                        case results <- i:
                        }
                    }
                }
            }
        }
    }()
    return session, nil
}

// run creates a daisy-chain of sub-matchers, one for the address set and one
// for each topic set, each sub-matcher receiving a section only if the previous
// ones have all found a potential match in one of the blocks of the section,
// then binary AND-ing its own matches and forwaring the result to the next one.
//
// The method starts feeding the section indexes into the first sub-matcher on a
// new goroutine and returns a sink channel receiving the results.
func (m *Matcher) run(begin, end uint64, buffer int, session *MatcherSession) chan *partialMatches {
    // Create the source channel and feed section indexes into
    source := make(chan *partialMatches, buffer)

    session.pend.Add(1)
    go func() {
        defer session.pend.Done()
        defer close(source)

        for i := begin / m.sectionSize; i <= end/m.sectionSize; i++ {
            select {
            case <-session.quit:
                return
            case source <- &partialMatches{i, bytes.Repeat([]byte{0xff}, int(m.sectionSize/8))}:
            }
        }
    }()
    // Assemble the daisy-chained filtering pipeline
    next := source
    dist := make(chan *request, buffer)

    for _, bloom := range m.filters {
        next = m.subMatch(next, dist, bloom, session)
    }
    // Start the request distribution
    session.pend.Add(1)
    go m.distributor(dist, session)

    return next
}

// subMatch creates a sub-matcher that filters for a set of addresses or topics, binary OR-s those matches, then
// binary AND-s the result to the daisy-chain input (source) and forwards it to the daisy-chain output.
// The matches of each address/topic are calculated by fetching the given sections of the three bloom bit indexes belonging to
// that address/topic, and binary AND-ing those vectors together.
func (m *Matcher) subMatch(source chan *partialMatches, dist chan *request, bloom []bloomIndexes, session *MatcherSession) chan *partialMatches {
    // Start the concurrent schedulers for each bit required by the bloom filter
    sectionSources := make([][3]chan uint64, len(bloom))
    sectionSinks := make([][3]chan []byte, len(bloom))
    for i, bits := range bloom {
        for j, bit := range bits {
            sectionSources[i][j] = make(chan uint64, cap(source))
            sectionSinks[i][j] = make(chan []byte, cap(source))

            m.schedulers[bit].run(sectionSources[i][j], dist, sectionSinks[i][j], session.quit, &session.pend)
        }
    }

    process := make(chan *partialMatches, cap(source)) // entries from source are forwarded here after fetches have been initiated
    results := make(chan *partialMatches, cap(source))

    session.pend.Add(2)
    go func() {
        // Tear down the goroutine and terminate all source channels
        defer session.pend.Done()
        defer close(process)

        defer func() {
            for _, bloomSources := range sectionSources {
                for _, bitSource := range bloomSources {
                    close(bitSource)
                }
            }
        }()
        // Read sections from the source channel and multiplex into all bit-schedulers
        for {
            select {
            case <-session.quit:
                return

            case subres, ok := <-source:
                // New subresult from previous link
                if !ok {
                    return
                }
                // Multiplex the section index to all bit-schedulers
                for _, bloomSources := range sectionSources {
                    for _, bitSource := range bloomSources {
                        select {
                        case <-session.quit:
                            return
                        case bitSource <- subres.section:
                        }
                    }
                }
                // Notify the processor that this section will become available
                select {
                case <-session.quit:
                    return
                case process <- subres:
                }
            }
        }
    }()

    go func() {
        // Tear down the goroutine and terminate the final sink channel
        defer session.pend.Done()
        defer close(results)

        // Read the source notifications and collect the delivered results
        for {
            select {
            case <-session.quit:
                return

            case subres, ok := <-process:
                // Notified of a section being retrieved
                if !ok {
                    return
                }
                // Gather all the sub-results and merge them together
                var orVector []byte
                for _, bloomSinks := range sectionSinks {
                    var andVector []byte
                    for _, bitSink := range bloomSinks {
                        var data []byte
                        select {
                        case <-session.quit:
                            return
                        case data = <-bitSink:
                        }
                        if andVector == nil {
                            andVector = make([]byte, int(m.sectionSize/8))
                            copy(andVector, data)
                        } else {
                            bitutil.ANDBytes(andVector, andVector, data)
                        }
                    }
                    if orVector == nil {
                        orVector = andVector
                    } else {
                        bitutil.ORBytes(orVector, orVector, andVector)
                    }
                }

                if orVector == nil {
                    orVector = make([]byte, int(m.sectionSize/8))
                }
                if subres.bitset != nil {
                    bitutil.ANDBytes(orVector, orVector, subres.bitset)
                }
                if bitutil.TestBytes(orVector) {
                    select {
                    case <-session.quit:
                        return
                    case results <- &partialMatches{subres.section, orVector}:
                    }
                }
            }
        }
    }()
    return results
}

// distributor receives requests from the schedulers and queues them into a set
// of pending requests, which are assigned to retrievers wanting to fulfil them.
func (m *Matcher) distributor(dist chan *request, session *MatcherSession) {
    defer session.pend.Done()

    var (
        requests   = make(map[uint][]uint64) // Per-bit list of section requests, ordered by section number
        unallocs   = make(map[uint]struct{}) // Bits with pending requests but not allocated to any retriever
        retrievers chan chan uint            // Waiting retrievers (toggled to nil if unallocs is empty)
    )
    var (
        allocs   int            // Number of active allocations to handle graceful shutdown requests
        shutdown = session.quit // Shutdown request channel, will gracefully wait for pending requests
    )

    // assign is a helper method fo try to assign a pending bit an an actively
    // listening servicer, or schedule it up for later when one arrives.
    assign := func(bit uint) {
        select {
        case fetcher := <-m.retrievers:
            allocs++
            fetcher <- bit
        default:
            // No retrievers active, start listening for new ones
            retrievers = m.retrievers
            unallocs[bit] = struct{}{}
        }
    }

    for {
        select {
        case <-shutdown:
            // Graceful shutdown requested, wait until all pending requests are honoured
            if allocs == 0 {
                return
            }
            shutdown = nil

        case <-session.kill:
            // Pending requests not honoured in time, hard terminate
            return

        case req := <-dist:
            // New retrieval request arrived to be distributed to some fetcher process
            queue := requests[req.bit]
            index := sort.Search(len(queue), func(i int) bool { return queue[i] >= req.section })
            requests[req.bit] = append(queue[:index], append([]uint64{req.section}, queue[index:]...)...)

            // If it's a new bit and we have waiting fetchers, allocate to them
            if len(queue) == 0 {
                assign(req.bit)
            }

        case fetcher := <-retrievers:
            // New retriever arrived, find the lowest section-ed bit to assign
            bit, best := uint(0), uint64(math.MaxUint64)
            for idx := range unallocs {
                if requests[idx][0] < best {
                    bit, best = idx, requests[idx][0]
                }
            }
            // Stop tracking this bit (and alloc notifications if no more work is available)
            delete(unallocs, bit)
            if len(unallocs) == 0 {
                retrievers = nil
            }
            allocs++
            fetcher <- bit

        case fetcher := <-m.counters:
            // New task count request arrives, return number of items
            fetcher <- uint(len(requests[<-fetcher]))

        case fetcher := <-m.retrievals:
            // New fetcher waiting for tasks to retrieve, assign
            task := <-fetcher
            if want := len(task.Sections); want >= len(requests[task.Bit]) {
                task.Sections = requests[task.Bit]
                delete(requests, task.Bit)
            } else {
                task.Sections = append(task.Sections[:0], requests[task.Bit][:want]...)
                requests[task.Bit] = append(requests[task.Bit][:0], requests[task.Bit][want:]...)
            }
            fetcher <- task

            // If anything was left unallocated, try to assign to someone else
            if len(requests[task.Bit]) > 0 {
                assign(task.Bit)
            }

        case result := <-m.deliveries:
            // New retrieval task response from fetcher, split out missing sections and
            // deliver complete ones
            var (
                sections = make([]uint64, 0, len(result.Sections))
                bitsets  = make([][]byte, 0, len(result.Bitsets))
                missing  = make([]uint64, 0, len(result.Sections))
            )
            for i, bitset := range result.Bitsets {
                if len(bitset) == 0 {
                    missing = append(missing, result.Sections[i])
                    continue
                }
                sections = append(sections, result.Sections[i])
                bitsets = append(bitsets, bitset)
            }
            m.schedulers[result.Bit].deliver(sections, bitsets)
            allocs--

            // Reschedule missing sections and allocate bit if newly available
            if len(missing) > 0 {
                queue := requests[result.Bit]
                for _, section := range missing {
                    index := sort.Search(len(queue), func(i int) bool { return queue[i] >= section })
                    queue = append(queue[:index], append([]uint64{section}, queue[index:]...)...)
                }
                requests[result.Bit] = queue

                if len(queue) == len(missing) {
                    assign(result.Bit)
                }
            }
            // If we're in the process of shutting down, terminate
            if allocs == 0 && shutdown == nil {
                return
            }
        }
    }
}

// MatcherSession is returned by a started matcher to be used as a terminator
// for the actively running matching operation.
type MatcherSession struct {
    matcher *Matcher

    quit chan struct{} // Quit channel to request pipeline termination
    kill chan struct{} // Term channel to signal non-graceful forced shutdown
    pend sync.WaitGroup
}

// Close stops the matching process and waits for all subprocesses to terminate
// before returning. The timeout may be used for graceful shutdown, allowing the
// currently running retrievals to complete before this time.
func (s *MatcherSession) Close(timeout time.Duration) {
    // Bail out if the matcher is not running
    select {
    case <-s.quit:
        return
    default:
    }
    // Signal termination and wait for all goroutines to tear down
    close(s.quit)
    time.AfterFunc(timeout, func() { close(s.kill) })
    s.pend.Wait()
}

// AllocateRetrieval assigns a bloom bit index to a client process that can either
// immediately reuest and fetch the section contents assigned to this bit or wait
// a little while for more sections to be requested.
func (s *MatcherSession) AllocateRetrieval() (uint, bool) {
    fetcher := make(chan uint)

    select {
    case <-s.quit:
        return 0, false
    case s.matcher.retrievers <- fetcher:
        bit, ok := <-fetcher
        return bit, ok
    }
}

// PendingSections returns the number of pending section retrievals belonging to
// the given bloom bit index.
func (s *MatcherSession) PendingSections(bit uint) int {
    fetcher := make(chan uint)

    select {
    case <-s.quit:
        return 0
    case s.matcher.counters <- fetcher:
        fetcher <- bit
        return int(<-fetcher)
    }
}

// AllocateSections assigns all or part of an already allocated bit-task queue
// to the requesting process.
func (s *MatcherSession) AllocateSections(bit uint, count int) []uint64 {
    fetcher := make(chan *Retrieval)

    select {
    case <-s.quit:
        return nil
    case s.matcher.retrievals <- fetcher:
        task := &Retrieval{
            Bit:      bit,
            Sections: make([]uint64, count),
        }
        fetcher <- task
        return (<-fetcher).Sections
    }
}

// DeliverSections delivers a batch of section bit-vectors for a specific bloom
// bit index to be injected into the processing pipeline.
func (s *MatcherSession) DeliverSections(bit uint, sections []uint64, bitsets [][]byte) {
    select {
    case <-s.kill:
        return
    case s.matcher.deliveries <- &Retrieval{Bit: bit, Sections: sections, Bitsets: bitsets}:
    }
}

// Multiplex polls the matcher session for rerieval tasks and multiplexes it into
// the reuested retrieval queue to be serviced together with other sessions.
//
// This method will block for the lifetime of the session. Even after termination
// of the session, any request in-flight need to be responded to! Empty responses
// are fine though in that case.
func (s *MatcherSession) Multiplex(batch int, wait time.Duration, mux chan chan *Retrieval) {
    for {
        // Allocate a new bloom bit index to retrieve data for, stopping when done
        bit, ok := s.AllocateRetrieval()
        if !ok {
            return
        }
        // Bit allocated, throttle a bit if we're below our batch limit
        if s.PendingSections(bit) < batch {
            select {
            case <-s.quit:
                // Session terminating, we can't meaningfully service, abort
                s.AllocateSections(bit, 0)
                s.DeliverSections(bit, []uint64{}, [][]byte{})
                return

            case <-time.After(wait):
                // Throttling up, fetch whatever's available
            }
        }
        // Allocate as much as we can handle and request servicing
        sections := s.AllocateSections(bit, batch)
        request := make(chan *Retrieval)

        select {
        case <-s.quit:
            // Session terminating, we can't meaningfully service, abort
            s.DeliverSections(bit, sections, make([][]byte, len(sections)))
            return

        case mux <- request:
            // Retrieval accepted, something must arrive before we're aborting
            request <- &Retrieval{Bit: bit, Sections: sections}

            result := <-request
            s.DeliverSections(result.Bit, result.Sections, result.Bitsets)
        }
    }
}