perf: Speedup flowrate by removing time.Now() from every update call #3016

ValarDragon · 2024-05-06T19:42:30Z

Closes #2958
Speeds up flowrate by removing time.Now() calls from every clock call, instead making one goroutine responsible for all clock reads. On my most recent mainnet benchmark, this should shave 14% off of the synchronous time in sending packets:

There may be slight differences at the boundary of these 20ms windows, but I do not think that is important.

PR checklist

Tests written/updated - existing tests pass
Changelog entry added in .changelog (we use unclog to manage our changelog)
Updated relevant documentation (docs/ or spec/) and code comments
Title follows the Conventional Commits spec

melekes

Thanks @ValarDragon ❤️

melekes · 2024-05-07T06:59:44Z

internal/flowrate/util.go

+	// sleep, then increment the clock value
+	// This is the only place the clock value is updated.
+	// Ensures that the clock value starts at 0.
+	for {


not sure how I feel about us not ever exiting here. I guess it's fine.

I can use some more CAS instructions to make it exit if all timers are done

EDIT didn't work

cason · 2024-05-07T17:28:45Z

Not sure if I agree with this approach.

Using an atomic int field to keep time at higher granularity is good. Using sleeps to increase it is not great, we can't trust that sleep sleeps what it is supposed to.

An alternative is to use something like time.Tick, which also returns a time, and adjust the increment of the atomic counter, in case the tick is longer than expected. In other words, if we expect a sleep duration of 10ms, but it for some reason (and it will do that), sleeps for 30ms, we increase the atomic counter by 3.

This reverts commit 6979902.

This reverts commit f72f3ac.

melekes · 2024-05-08T06:18:10Z

Using an atomic int field to keep time at higher granularity is good. Using sleeps to increase it is not great, we can't trust that sleep sleeps what it is supposed to.

Good point 👍

ValarDragon · 2024-05-14T02:16:03Z

Great point! Fixed in latest commit

internal/flowrate/util.go

melekes

👍

github-actions · 2024-05-25T00:13:32Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

ValarDragon · 2024-05-25T01:49:03Z

I think this PR is good to go!

sergio-mena

LGTM

…ometbft#3016) Closes cometbft#2958 Speeds up flowrate by removing time.Now() calls from every `clock` call, instead making one goroutine responsible for all clock reads. On my most recent mainnet benchmark, this should shave 14% off of the synchronous time in sending packets: ![image](https://github.com/cometbft/cometbft/assets/6440154/f2f65080-7bf1-4c4c-9775-774d97ed016a) There may be slight differences at the boundary of these 20ms windows, but I do not think that is important. --- - [x] Tests written/updated - existing tests pass - [x] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec

…ometbft#3016) Closes cometbft#2958 Speeds up flowrate by removing time.Now() calls from every `clock` call, instead making one goroutine responsible for all clock reads. On my most recent mainnet benchmark, this should shave 14% off of the synchronous time in sending packets: ![image](https://github.com/cometbft/cometbft/assets/6440154/f2f65080-7bf1-4c4c-9775-774d97ed016a) There may be slight differences at the boundary of these 20ms windows, but I do not think that is important. --- - [x] Tests written/updated - existing tests pass - [x] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit 8d51a10)

adizere · 2024-07-04T10:07:28Z

Should we backport anything from here into .37 or .38 ?

ValarDragon · 2024-07-04T17:03:10Z

Yes please, lets backport to 38!

melekes · 2024-07-10T07:09:22Z

@mergify backport v1.x

mergify · 2024-07-10T07:09:55Z

backport v1.x

✅ Backports have been created

#3467 perf: Speedup flowrate by removing time.Now() from every update call (backport #3016) has been created for branch v1.x but encountered conflicts

…3016) Closes #2958 Speeds up flowrate by removing time.Now() calls from every `clock` call, instead making one goroutine responsible for all clock reads. On my most recent mainnet benchmark, this should shave 14% off of the synchronous time in sending packets: ![image](https://github.com/cometbft/cometbft/assets/6440154/f2f65080-7bf1-4c4c-9775-774d97ed016a) There may be slight differences at the boundary of these 20ms windows, but I do not think that is important. --- #### PR checklist - [x] Tests written/updated - existing tests pass - [x] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit 4513c68) # Conflicts: # .changelog/unreleased/improvements/3016-remove-expensive-calls-from-flowrate.md

…(backport #3016) (#3467) Closes #2958 Speeds up flowrate by removing time.Now() calls from every `clock` call, instead making one goroutine responsible for all clock reads. On my most recent mainnet benchmark, this should shave 14% off of the synchronous time in sending packets: ![image](https://github.com/cometbft/cometbft/assets/6440154/f2f65080-7bf1-4c4c-9775-774d97ed016a) There may be slight differences at the boundary of these 20ms windows, but I do not think that is important. --- #### PR checklist - [x] Tests written/updated - existing tests pass - [x] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request #3016 done by [Mergify](https://mergify.com). --------- Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com> Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

…(backport cometbft#3016) (cometbft#3467) Closes cometbft#2958 Speeds up flowrate by removing time.Now() calls from every `clock` call, instead making one goroutine responsible for all clock reads. On my most recent mainnet benchmark, this should shave 14% off of the synchronous time in sending packets: ![image](https://github.com/cometbft/cometbft/assets/6440154/f2f65080-7bf1-4c4c-9775-774d97ed016a) There may be slight differences at the boundary of these 20ms windows, but I do not think that is important. --- - [x] Tests written/updated - existing tests pass - [x] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [x] Updated relevant documentation (`docs/` or `spec/`) and code comments - [x] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec <hr>This is an automatic backport of pull request cometbft#3016 done by [Mergify](https://mergify.com). --------- Co-authored-by: Dev Ojha <ValarDragon@users.noreply.github.com> Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>

Speedup flowrate by removing time.Now() from every update call

0a9fe57

ValarDragon requested review from a team as code owners May 6, 2024 19:42

ValarDragon added 2 commits May 6, 2024 12:44

Fix typo

be73641

Fix lint, code docs & changelog

351badd

melekes approved these changes May 7, 2024

View reviewed changes

ValarDragon added 2 commits May 7, 2024 10:16

Make flowrate timer loop exit if all timers are done

f72f3ac

delete unused

6979902

ValarDragon added 2 commits May 7, 2024 13:05

Revert "delete unused"

481f7a2

This reverts commit 6979902.

Revert "Make flowrate timer loop exit if all timers are done"

6397e25

This reverts commit f72f3ac.

Use ticker.Tick

f1d1789

melekes reviewed May 14, 2024

View reviewed changes

internal/flowrate/util.go Outdated Show resolved Hide resolved

melekes reviewed May 14, 2024

View reviewed changes

internal/flowrate/util.go Outdated Show resolved Hide resolved

melekes reviewed May 14, 2024

View reviewed changes

internal/flowrate/util.go Outdated Show resolved Hide resolved

melekes reviewed May 14, 2024

View reviewed changes

internal/flowrate/util.go Outdated Show resolved Hide resolved

Use time.Ticker per @melekes ' suggestion

25fa9f9

melekes approved these changes May 14, 2024

View reviewed changes

github-actions bot added the stale For use by stalebot label May 25, 2024

Merge branch 'main' into dev/speedup_flowrate

0f4077b

sergio-mena approved these changes May 27, 2024

View reviewed changes

melekes added this pull request to the merge queue May 27, 2024

Merged via the queue into cometbft:main with commit 4513c68 May 27, 2024
36 checks passed

sergio-mena removed the stale For use by stalebot label May 27, 2024

ValarDragon mentioned this pull request May 31, 2024

perf: Speedup flowrate by removing time.Now() from every update call … osmosis-labs/cometbft#88

Merged

7 tasks

mergify bot mentioned this pull request May 31, 2024

perf: Speedup flowrate by removing time.Now() from every update call … (backport #88) osmosis-labs/cometbft#89

Merged

7 tasks

mergify bot mentioned this pull request Jul 10, 2024

perf: Speedup flowrate by removing time.Now() from every update call (backport #3016) #3467

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

perf: Speedup flowrate by removing time.Now() from every update call #3016

perf: Speedup flowrate by removing time.Now() from every update call #3016

ValarDragon commented May 6, 2024 •

edited

Loading

melekes left a comment

melekes May 7, 2024

ValarDragon May 7, 2024 •

edited

Loading

ValarDragon May 7, 2024

cason commented May 7, 2024

melekes commented May 8, 2024

ValarDragon commented May 14, 2024

melekes left a comment

github-actions bot commented May 25, 2024

ValarDragon commented May 25, 2024

sergio-mena left a comment

adizere commented Jul 4, 2024

ValarDragon commented Jul 4, 2024

melekes commented Jul 10, 2024

mergify bot commented Jul 10, 2024 •

edited

Loading

perf: Speedup flowrate by removing time.Now() from every update call #3016

perf: Speedup flowrate by removing time.Now() from every update call #3016

Conversation

ValarDragon commented May 6, 2024 • edited Loading

PR checklist

melekes left a comment

Choose a reason for hiding this comment

melekes May 7, 2024

Choose a reason for hiding this comment

ValarDragon May 7, 2024 • edited Loading

Choose a reason for hiding this comment

ValarDragon May 7, 2024

Choose a reason for hiding this comment

cason commented May 7, 2024

melekes commented May 8, 2024

ValarDragon commented May 14, 2024

melekes left a comment

Choose a reason for hiding this comment

github-actions bot commented May 25, 2024

ValarDragon commented May 25, 2024

sergio-mena left a comment

Choose a reason for hiding this comment

adizere commented Jul 4, 2024

ValarDragon commented Jul 4, 2024

melekes commented Jul 10, 2024

mergify bot commented Jul 10, 2024 • edited Loading

✅ Backports have been created

ValarDragon commented May 6, 2024 •

edited

Loading

ValarDragon May 7, 2024 •

edited

Loading

mergify bot commented Jul 10, 2024 •

edited

Loading