status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update `sync_queue` docs w.r.t. joker's problem (#4317) 

Explicitly mention in-line documentation within `sync_queue` relating to
older specification version to make rationale clearer.
This commit is contained in:
Etan Kissling 2022-11-11 15:36:02 +01:00 committed by GitHub
parent 94ff73af34
commit 93714756d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
beacon_chain/sync/sync_queue.nim
View File

@ -181,7 +181,7 @@ proc init*[T](t1: typedesc[SyncQueue], t2: typedesc[T],
ident: string = "main"): SyncQueue[T] = ident: string = "main"): SyncQueue[T] =
## Create new synchronization queue with parameters ## Create new synchronization queue with parameters
## ##
## ``start`` and ``last`` are starting and finishing Slots. ## ``start`` and ``final`` are starting and final Slots.
## ##
## ``chunkSize`` maximum number of slots in one request. ## ``chunkSize`` maximum number of slots in one request.
## ##
@ -197,10 +197,11 @@ proc init*[T](t1: typedesc[SyncQueue], t2: typedesc[T],
# #
# Joker's problem # Joker's problem
# #
# According to current Ethereum2 network specification # According to pre-v0.12.0 Ethereum consensus network specification
# > Clients MUST respond with at least one block, if they have it and it # > Clients MUST respond with at least one block, if they have it and it
# > exists in the range. Clients MAY limit the number of blocks in the # > exists in the range. Clients MAY limit the number of blocks in the
# > response. # > response.
# https://github.com/ethereum/consensus-specs/blob/v0.11.3/specs/phase0/p2p-interface.md#L590
# #
# Such rule can lead to very uncertain responses, for example let slots from # Such rule can lead to very uncertain responses, for example let slots from
# 10 to 12 will be not empty. Client which follows specification can answer # 10 to 12 will be not empty. Client which follows specification can answer
@ -214,18 +215,24 @@ proc init*[T](t1: typedesc[SyncQueue], t2: typedesc[T],
# 6. X - X # 6. X - X
# 7. X X - # 7. X X -
# #
# If peer answers with `1` everything will be fine and `block_pool` will be # If peer answers with `1` everything will be fine and `block_processor`
# able to process all 3 blocks. In case of `2`, `3`, `4`, `6` - `block_pool` # will be able to process all 3 blocks.
# will fail immediately with chunk and report "parent is missing" error. # In case of `2`, `3`, `4`, `6` - `block_processor` will fail immediately
# But in case of `5` and `7` blocks will be processed by `block_pool` without # with chunk and report "parent is missing" error.
# any problems, however it will start producing problems right from this # But in case of `5` and `7` blocks will be processed by `block_processor`
# uncertain last slot. SyncQueue will start producing requests for next # without any problems, however it will start producing problems right from
# this uncertain last slot. SyncQueue will start producing requests for next
# blocks, but all the responses from this point will fail with "parent is # blocks, but all the responses from this point will fail with "parent is
# missing" error. Lets call such peers "jokers", because they are joking # missing" error. Lets call such peers "jokers", because they are joking
# with responses. # with responses.
# #
# To fix "joker" problem we going to perform rollback to the latest finalized # To fix "joker" problem we going to perform rollback to the latest finalized
# epoch's first slot. # epoch's first slot.
#
# Note that as of spec v0.12.0, well-behaving clients are forbidden from
# answering this way. However, it still makes sense to attempt to handle
# this case to increase compatibility (e.g., with weak subjectivity nodes
# that are still backfilling blocks)
doAssert(chunkSize > 0'u64, "Chunk size should not be zero") doAssert(chunkSize > 0'u64, "Chunk size should not be zero")
SyncQueue[T]( SyncQueue[T](
kind: queueKind, kind: queueKind,
@ -307,7 +314,7 @@ proc waitForChanges[T](sq: SyncQueue[T]): Future[bool] {.async.} =
sq.waiters.delete(sq.waiters.find(waititem)) sq.waiters.delete(sq.waiters.find(waititem))
proc wakeupAndWaitWaiters[T](sq: SyncQueue[T]) {.async.} = proc wakeupAndWaitWaiters[T](sq: SyncQueue[T]) {.async.} =
## This procedure will perform wakeupWaiters(false) and blocks until last ## This procedure will perform wakeupWaiters(true) and blocks until last
## waiter will be awakened. ## waiter will be awakened.
var waitChanges = sq.waitForChanges() var waitChanges = sq.waitForChanges()
sq.wakeupWaiters(true) sq.wakeupWaiters(true)