roysc/plugeth
1
0
Fork 0
forked from cerc-io/plugeth
Code Pull Requests Activity

core/bloombits: use single channel for shutdown (#20878)

Browse Source 
This replaces the two-stage shutdown scheme with the one we
use almost everywhere else: a single quit channel signalling
termination.

Co-authored-by: Felix Lange <fjl@twurst.com>
This commit is contained in:
ucwong 2020-07-29 19:49:12 +08:00 committed by GitHub
parent abf2d7d74f
commit 9e04c5ec83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
core/bloombits/matcher.go
View File

@ -155,7 +155,6 @@ func (m *Matcher) Start(ctx context.Context, begin, end uint64, results chan uin
session := &MatcherSession{ session := &MatcherSession{
matcher: m, matcher: m,
quit: make(chan struct{}), quit: make(chan struct{}),
kill: make(chan struct{}),
ctx: ctx, ctx: ctx,
} }
for _, scheduler := range m.schedulers { for _, scheduler := range m.schedulers {
@ -386,10 +385,8 @@ func (m *Matcher) distributor(dist chan *request, session *MatcherSession) {
requests = make(map[uint][]uint64) // Per-bit list of section requests, ordered by section number 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 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) retrievers chan chan uint // Waiting retrievers (toggled to nil if unallocs is empty)
) allocs int // Number of active allocations to handle graceful shutdown requests
var ( shutdown = session.quit // Shutdown request channel, will gracefully wait for pending requests
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 actively // assign is a helper method fo try to assign a pending bit an actively
@ -409,15 +406,12 @@ func (m *Matcher) distributor(dist chan *request, session *MatcherSession) {
for { for {
select { select {
case <-shutdown: case <-shutdown:
// Graceful shutdown requested, wait until all pending requests are honoured // Shutdown requested. No more retrievers can be allocated,
// but we still need to wait until all pending requests have returned.
shutdown = nil
if allocs == 0 { if allocs == 0 {
return return
} }
shutdown = nil
case <-session.kill:
// Pending requests not honoured in time, hard terminate
return
case req := <-dist: case req := <-dist:
// New retrieval request arrived to be distributed to some fetcher process // New retrieval request arrived to be distributed to some fetcher process
@ -499,8 +493,9 @@ func (m *Matcher) distributor(dist chan *request, session *MatcherSession) {
assign(result.Bit) assign(result.Bit)
} }
} }
// If we're in the process of shutting down, terminate
if allocs == 0 && shutdown == nil { // End the session when all pending deliveries have arrived.
if shutdown == nil && allocs == 0 {
return return
} }
} }
@ -514,7 +509,6 @@ type MatcherSession struct {
closer sync.Once // Sync object to ensure we only ever close once closer sync.Once // Sync object to ensure we only ever close once
quit chan struct{} // Quit channel to request pipeline termination quit chan struct{} // Quit channel to request pipeline termination
kill chan struct{} // Term channel to signal non-graceful forced shutdown
ctx context.Context // Context used by the light client to abort filtering ctx context.Context // Context used by the light client to abort filtering
err atomic.Value // Global error to track retrieval failures deep in the chain err atomic.Value // Global error to track retrieval failures deep in the chain
@ -529,7 +523,6 @@ func (s *MatcherSession) Close() {
s.closer.Do(func() { s.closer.Do(func() {
// Signal termination and wait for all goroutines to tear down // Signal termination and wait for all goroutines to tear down
close(s.quit) close(s.quit)
time.AfterFunc(time.Second, func() { close(s.kill) })
s.pend.Wait() s.pend.Wait()
}) })
} }
@ -542,10 +535,10 @@ func (s *MatcherSession) Error() error {
return nil return nil
} }
// AllocateRetrieval assigns a bloom bit index to a client process that can either // allocateRetrieval assigns a bloom bit index to a client process that can either
// immediately request and fetch the section contents assigned to this bit or wait // immediately request and fetch the section contents assigned to this bit or wait
// a little while for more sections to be requested. // a little while for more sections to be requested.
func (s *MatcherSession) AllocateRetrieval() (uint, bool) { func (s *MatcherSession) allocateRetrieval() (uint, bool) {
fetcher := make(chan uint) fetcher := make(chan uint)
select { select {
@ -557,9 +550,9 @@ func (s *MatcherSession) AllocateRetrieval() (uint, bool) {
} }
} }
// PendingSections returns the number of pending section retrievals belonging to // pendingSections returns the number of pending section retrievals belonging to
// the given bloom bit index. // the given bloom bit index.
func (s *MatcherSession) PendingSections(bit uint) int { func (s *MatcherSession) pendingSections(bit uint) int {
fetcher := make(chan uint) fetcher := make(chan uint)
select { select {
@ -571,9 +564,9 @@ func (s *MatcherSession) PendingSections(bit uint) int {
} }
} }
// AllocateSections assigns all or part of an already allocated bit-task queue // allocateSections assigns all or part of an already allocated bit-task queue
// to the requesting process. // to the requesting process.
func (s *MatcherSession) AllocateSections(bit uint, count int) []uint64 { func (s *MatcherSession) allocateSections(bit uint, count int) []uint64 {
fetcher := make(chan *Retrieval) fetcher := make(chan *Retrieval)
select { select {
@ -589,14 +582,10 @@ func (s *MatcherSession) AllocateSections(bit uint, count int) []uint64 {
} }
} }
// DeliverSections delivers a batch of section bit-vectors for a specific bloom // deliverSections delivers a batch of section bit-vectors for a specific bloom
// bit index to be injected into the processing pipeline. // bit index to be injected into the processing pipeline.
func (s *MatcherSession) DeliverSections(bit uint, sections []uint64, bitsets [][]byte) { func (s *MatcherSession) deliverSections(bit uint, sections []uint64, bitsets [][]byte) {
select { s.matcher.deliveries <- &Retrieval{Bit: bit, Sections: sections, Bitsets: bitsets}
case <-s.kill:
return
case s.matcher.deliveries <- &Retrieval{Bit: bit, Sections: sections, Bitsets: bitsets}:
}
} }
// Multiplex polls the matcher session for retrieval tasks and multiplexes it into // Multiplex polls the matcher session for retrieval tasks and multiplexes it into
@ -608,17 +597,17 @@ func (s *MatcherSession) DeliverSections(bit uint, sections []uint64, bitsets []
func (s *MatcherSession) Multiplex(batch int, wait time.Duration, mux chan chan *Retrieval) { func (s *MatcherSession) Multiplex(batch int, wait time.Duration, mux chan chan *Retrieval) {
for { for {
// Allocate a new bloom bit index to retrieve data for, stopping when done // Allocate a new bloom bit index to retrieve data for, stopping when done
bit, ok := s.AllocateRetrieval() bit, ok := s.allocateRetrieval()
if !ok { if !ok {
return return
} }
// Bit allocated, throttle a bit if we're below our batch limit // Bit allocated, throttle a bit if we're below our batch limit
if s.PendingSections(bit) < batch { if s.pendingSections(bit) < batch {
select { select {
case <-s.quit: case <-s.quit:
// Session terminating, we can't meaningfully service, abort // Session terminating, we can't meaningfully service, abort
s.AllocateSections(bit, 0) s.allocateSections(bit, 0)
s.DeliverSections(bit, []uint64{}, [][]byte{}) s.deliverSections(bit, []uint64{}, [][]byte{})
return return
case <-time.After(wait): case <-time.After(wait):
@ -626,13 +615,13 @@ func (s *MatcherSession) Multiplex(batch int, wait time.Duration, mux chan chan
} }
} }
// Allocate as much as we can handle and request servicing // Allocate as much as we can handle and request servicing
sections := s.AllocateSections(bit, batch) sections := s.allocateSections(bit, batch)
request := make(chan *Retrieval) request := make(chan *Retrieval)
select { select {
case <-s.quit: case <-s.quit:
// Session terminating, we can't meaningfully service, abort // Session terminating, we can't meaningfully service, abort
s.DeliverSections(bit, sections, make([][]byte, len(sections))) s.deliverSections(bit, sections, make([][]byte, len(sections)))
return return
case mux <- request: case mux <- request:
@ -644,7 +633,7 @@ func (s *MatcherSession) Multiplex(batch int, wait time.Duration, mux chan chan
s.err.Store(result.Error) s.err.Store(result.Error)
s.Close() s.Close()
} }
s.DeliverSections(result.Bit, result.Sections, result.Bitsets) s.deliverSections(result.Bit, result.Sections, result.Bitsets)
} }
} }
} }