Simplify simulation messaging with priority queue and parameterise GST #209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
masih
force-pushed
the
masih/sim-msg-priority-queue
branch
2 times, most recently
from
1bf3314
to
a0d96e5
Compare
Kubuxu
approved these changes
May 13, 2024
masih
force-pushed
the
masih/sim-msg-priority-queue
branch
from
a0d96e5
to
b4ef5a0
Compare
Use `heap.Interface` to simplify the implementation of message passing during simulation by implementing a priority queue. The messages in-flight are priorities in ascending order of their `deliverAt` time, i.e. messages with earlier delivery time have higher priority. Additionally, explicitly introduce an option to set Global Stabilization Time (GST). GST duration is one of the fundamental assumptions made by gPBFT, beyond which message delivery is assumed to be guaranteed. Enhance Withold adversary tests with varying GST time. Relates to #196
masih
force-pushed
the
masih/sim-msg-priority-queue
branch
from
b4ef5a0
to
ee3c5e2
Compare
anorth
reviewed
May 14, 2024
| func (pq *messageQueue) Pop() any { | ||
| old := pq.mailbox | ||
| n := len(old) | ||
| item := old[n-1] |
There was a problem hiding this comment.
This looks like it's removing the lowest priority (highest deliverAt) item, if they are in ascending order. Which I don't think is what we want here.
This message queue is lacking tests (my fault).
There was a problem hiding this comment.
The implementation of Pop is correct, i.e. adheres to what heap.Interface demands. It's my documentation that's misleading; apologies.
Unit tests are added here along with documentation correction.
Comment on lines
+144
to
+145
| if adv != nil && !n.globalStabilisationElapsed { | ||
| if n.hasGlobalStabilizationTimeElapsed() { |
There was a problem hiding this comment.
This is a bit confusing to read. We should just remove the boolean field if this can be calculated instead.
There was a problem hiding this comment.
We need the boolean filed to cache that GST has elapsed. Because, otherwise the simulation logs "GST elapsed" on every tick after GST has elapsed.
If you are happy for the log line to be removed then we can totally get rid of the boolean flag.
masih
added a commit
that referenced
this pull request
May 15, 2024
Assert that simulation priority queue used to order message delivery is behaving as expected: * queued messages are sorted in ascending order of their `deliverAt`. * removal of a message returns the one with earliest `deliverAt`. * conditional upsert is respected. * duplicate messages are allowed and ordered as expected. * queue is fully drained upon removing all messages. Update misleading godoc for `Pop` receiver. Addresses #209 (comment)
masih
added a commit
that referenced
this pull request
May 15, 2024
Assert that simulation priority queue used to order message delivery is behaving as expected: * queued messages are sorted in ascending order of their `deliverAt`. * removal of a message returns the one with earliest `deliverAt`. * conditional upsert is respected. * duplicate messages are allowed and ordered as expected. * queue is fully drained upon removing all messages. Update misleading godoc for `Pop` receiver. Addresses #209 (comment)
masih
added a commit
that referenced
this pull request
May 15, 2024
Assert that simulation priority queue used to order message delivery is behaving as expected: * queued messages are sorted in ascending order of their `deliverAt`. * removal of a message returns the one with earliest `deliverAt`. * conditional upsert is respected. * duplicate messages are allowed and ordered as expected. * queue is fully drained upon removing all messages. Update misleading godoc for `Pop` receiver. Addresses #209 (comment)
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 15, 2024
Assert that simulation priority queue used to order message delivery is behaving as expected: * queued messages are sorted in ascending order of their `deliverAt`. * removal of a message returns the one with earliest `deliverAt`. * conditional upsert is respected. * duplicate messages are allowed and ordered as expected. * queue is fully drained upon removing all messages. Update misleading godoc for `Pop` receiver. Addresses #209 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use
heap.Interfaceto simplify the implementation of message passing during simulation by implementing a priority queue. The messages in-flight are priorities in ascending order of theirdeliverAttime, i.e. messages with earlier delivery time have higher priority.Additionally, explicitly introduce an option to set Global Stabilization Time (GST). GST duration is one of the fundamental assumptions made by gPBFT, beyond which message delivery is assumed to be guaranteed. Enhance Withold adversary tests with varying GST time.
Relates to #196