Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Utils buffer sv2 docs #1232

Merged
merged 12 commits into from
Dec 11, 2024
Merged

Conversation

rrybarczyk
Copy link
Collaborator

Addresses #1184.

@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation util Common utilities/helpers protocols Lowest level protocol logic labels Oct 21, 2024
@rrybarczyk rrybarczyk self-assigned this Oct 21, 2024
@rrybarczyk rrybarczyk linked an issue Oct 21, 2024 that may be closed by this pull request
Copy link

codecov bot commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 19.30%. Comparing base (04caafb) to head (13ab37d).
Report is 13 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1232   +/-   ##
=======================================
  Coverage   19.30%   19.30%           
=======================================
  Files         164      164           
  Lines       10849    10849           
=======================================
  Hits         2094     2094           
  Misses       8755     8755           
Flag Coverage Δ
binary_codec_sv2-coverage 0.00% <ø> (ø)
binary_serde_sv2-coverage 3.65% <ø> (ø)
binary_sv2-coverage 5.48% <ø> (ø)
bip32_derivation-coverage 0.00% <ø> (ø)
buffer_sv2-coverage 25.02% <ø> (ø)
codec_sv2-coverage 0.01% <ø> (ø)
common_messages_sv2-coverage 0.13% <ø> (ø)
const_sv2-coverage 0.00% <ø> (ø)
error_handling-coverage 0.00% <ø> (ø)
framing_sv2-coverage 0.29% <ø> (ø)
jd_client-coverage 0.00% <ø> (ø)
jd_server-coverage 7.79% <ø> (ø)
job_declaration_sv2-coverage 0.00% <ø> (ø)
key-utils-coverage 2.39% <ø> (ø)
mining-coverage 2.51% <ø> (ø)
mining_device-coverage 0.00% <ø> (ø)
mining_proxy_sv2-coverage 0.70% <ø> (ø)
noise_sv2-coverage 4.35% <ø> (ø)
pool_sv2-coverage 1.38% <ø> (ø)
protocols 24.72% <ø> (ø)
roles 6.55% <ø> (ø)
roles_logic_sv2-coverage 8.08% <ø> (ø)
sv2_ffi-coverage 0.00% <ø> (ø)
template_distribution_sv2-coverage 0.00% <ø> (ø)
translator_sv2-coverage 9.60% <ø> (ø)
utils 25.13% <ø> (ø)
v1-coverage 2.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

github-actions bot commented Oct 21, 2024

🐰 Bencher Report

Branch1232/merge
Testbedsv2

⚠️ WARNING: The following Measures do not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkEstimated Cyclesestimated cyclesInstructionsinstructionsL1 AccessesaccessesL2 AccessesaccessesRAM Accessesaccesses
client_sv2_handle_message_common📈 view plot
⚠️ NO THRESHOLD
2,137.00📈 view plot
⚠️ NO THRESHOLD
473.00📈 view plot
⚠️ NO THRESHOLD
732.00📈 view plot
⚠️ NO THRESHOLD
8.00📈 view plot
⚠️ NO THRESHOLD
39.00
client_sv2_handle_message_mining📈 view plot
⚠️ NO THRESHOLD
8,204.00📈 view plot
⚠️ NO THRESHOLD
2,137.00📈 view plot
⚠️ NO THRESHOLD
3,159.00📈 view plot
⚠️ NO THRESHOLD
36.00📈 view plot
⚠️ NO THRESHOLD
139.00
client_sv2_mining_message_submit_standard📈 view plot
⚠️ NO THRESHOLD
6,327.00📈 view plot
⚠️ NO THRESHOLD
1,750.00📈 view plot
⚠️ NO THRESHOLD
2,547.00📈 view plot
⚠️ NO THRESHOLD
21.00📈 view plot
⚠️ NO THRESHOLD
105.00
client_sv2_mining_message_submit_standard_serialize📈 view plot
⚠️ NO THRESHOLD
14,712.00📈 view plot
⚠️ NO THRESHOLD
4,694.00📈 view plot
⚠️ NO THRESHOLD
6,757.00📈 view plot
⚠️ NO THRESHOLD
44.00📈 view plot
⚠️ NO THRESHOLD
221.00
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
27,522.00📈 view plot
⚠️ NO THRESHOLD
10,585.00📈 view plot
⚠️ NO THRESHOLD
15,397.00📈 view plot
⚠️ NO THRESHOLD
87.00📈 view plot
⚠️ NO THRESHOLD
334.00
client_sv2_open_channel📈 view plot
⚠️ NO THRESHOLD
4,379.00📈 view plot
⚠️ NO THRESHOLD
1,461.00📈 view plot
⚠️ NO THRESHOLD
2,159.00📈 view plot
⚠️ NO THRESHOLD
10.00📈 view plot
⚠️ NO THRESHOLD
62.00
client_sv2_open_channel_serialize📈 view plot
⚠️ NO THRESHOLD
13,974.00📈 view plot
⚠️ NO THRESHOLD
5,064.00📈 view plot
⚠️ NO THRESHOLD
7,329.00📈 view plot
⚠️ NO THRESHOLD
34.00📈 view plot
⚠️ NO THRESHOLD
185.00
client_sv2_open_channel_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
22,727.00📈 view plot
⚠️ NO THRESHOLD
8,027.00📈 view plot
⚠️ NO THRESHOLD
11,667.00📈 view plot
⚠️ NO THRESHOLD
84.00📈 view plot
⚠️ NO THRESHOLD
304.00
client_sv2_setup_connection📈 view plot
⚠️ NO THRESHOLD
4,715.00📈 view plot
⚠️ NO THRESHOLD
1,502.00📈 view plot
⚠️ NO THRESHOLD
2,275.00📈 view plot
⚠️ NO THRESHOLD
12.00📈 view plot
⚠️ NO THRESHOLD
68.00
client_sv2_setup_connection_serialize📈 view plot
⚠️ NO THRESHOLD
16,140.00📈 view plot
⚠️ NO THRESHOLD
5,963.00📈 view plot
⚠️ NO THRESHOLD
8,665.00📈 view plot
⚠️ NO THRESHOLD
39.00📈 view plot
⚠️ NO THRESHOLD
208.00
client_sv2_setup_connection_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
35,538.00📈 view plot
⚠️ NO THRESHOLD
14,855.00📈 view plot
⚠️ NO THRESHOLD
21,818.00📈 view plot
⚠️ NO THRESHOLD
98.00📈 view plot
⚠️ NO THRESHOLD
378.00
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 21, 2024

🐰 Bencher Report

Branch1232/merge
Testbedsv1

⚠️ WARNING: The following Measures do not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkEstimated Cyclesestimated cyclesInstructionsinstructionsL1 AccessesaccessesL2 AccessesaccessesRAM Accessesaccesses
get_authorize📈 view plot
⚠️ NO THRESHOLD
8,383.00📈 view plot
⚠️ NO THRESHOLD
3,689.00📈 view plot
⚠️ NO THRESHOLD
5,158.00📈 view plot
⚠️ NO THRESHOLD
8.00📈 view plot
⚠️ NO THRESHOLD
91.00
get_submit📈 view plot
⚠️ NO THRESHOLD
95,381.00📈 view plot
⚠️ NO THRESHOLD
59,346.00📈 view plot
⚠️ NO THRESHOLD
85,221.00📈 view plot
⚠️ NO THRESHOLD
44.00📈 view plot
⚠️ NO THRESHOLD
284.00
get_subscribe📈 view plot
⚠️ NO THRESHOLD
7,876.00📈 view plot
⚠️ NO THRESHOLD
2,765.00📈 view plot
⚠️ NO THRESHOLD
3,846.00📈 view plot
⚠️ NO THRESHOLD
15.00📈 view plot
⚠️ NO THRESHOLD
113.00
serialize_authorize📈 view plot
⚠️ NO THRESHOLD
12,210.00📈 view plot
⚠️ NO THRESHOLD
5,266.00📈 view plot
⚠️ NO THRESHOLD
7,325.00📈 view plot
⚠️ NO THRESHOLD
11.00📈 view plot
⚠️ NO THRESHOLD
138.00
serialize_deserialize_authorize📈 view plot
⚠️ NO THRESHOLD
24,306.00📈 view plot
⚠️ NO THRESHOLD
9,838.00📈 view plot
⚠️ NO THRESHOLD
13,891.00📈 view plot
⚠️ NO THRESHOLD
32.00📈 view plot
⚠️ NO THRESHOLD
293.00
serialize_deserialize_handle_authorize📈 view plot
⚠️ NO THRESHOLD
30,016.00📈 view plot
⚠️ NO THRESHOLD
12,015.00📈 view plot
⚠️ NO THRESHOLD
17,001.00📈 view plot
⚠️ NO THRESHOLD
62.00📈 view plot
⚠️ NO THRESHOLD
363.00
serialize_deserialize_handle_submit📈 view plot
⚠️ NO THRESHOLD
126,279.00📈 view plot
⚠️ NO THRESHOLD
73,200.00📈 view plot
⚠️ NO THRESHOLD
104,914.00📈 view plot
⚠️ NO THRESHOLD
108.00📈 view plot
⚠️ NO THRESHOLD
595.00
serialize_deserialize_handle_subscribe📈 view plot
⚠️ NO THRESHOLD
27,392.00📈 view plot
⚠️ NO THRESHOLD
9,584.00📈 view plot
⚠️ NO THRESHOLD
13,547.00📈 view plot
⚠️ NO THRESHOLD
67.00📈 view plot
⚠️ NO THRESHOLD
386.00
serialize_deserialize_submit📈 view plot
⚠️ NO THRESHOLD
115,049.00📈 view plot
⚠️ NO THRESHOLD
68,060.00📈 view plot
⚠️ NO THRESHOLD
97,659.00📈 view plot
⚠️ NO THRESHOLD
62.00📈 view plot
⚠️ NO THRESHOLD
488.00
serialize_deserialize_subscribe📈 view plot
⚠️ NO THRESHOLD
22,820.00📈 view plot
⚠️ NO THRESHOLD
8,143.00📈 view plot
⚠️ NO THRESHOLD
11,465.00📈 view plot
⚠️ NO THRESHOLD
38.00📈 view plot
⚠️ NO THRESHOLD
319.00
serialize_submit📈 view plot
⚠️ NO THRESHOLD
99,770.00📈 view plot
⚠️ NO THRESHOLD
61,408.00📈 view plot
⚠️ NO THRESHOLD
88,080.00📈 view plot
⚠️ NO THRESHOLD
49.00📈 view plot
⚠️ NO THRESHOLD
327.00
serialize_subscribe📈 view plot
⚠️ NO THRESHOLD
11,321.00📈 view plot
⚠️ NO THRESHOLD
4,118.00📈 view plot
⚠️ NO THRESHOLD
5,706.00📈 view plot
⚠️ NO THRESHOLD
17.00📈 view plot
⚠️ NO THRESHOLD
158.00
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 21, 2024

🐰 Bencher Report

Branch1232/merge
Testbedsv1

⚠️ WARNING: The following Measure does not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkLatencynanoseconds (ns)
client-submit-serialize📈 view plot
⚠️ NO THRESHOLD
6,782.20
client-submit-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
7,407.60
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
8,156.30
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
872.09
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
668.84
client-sv1-authorize-serialize/client-sv1-authorize-serialize📈 view plot
⚠️ NO THRESHOLD
247.90
client-sv1-get-authorize/client-sv1-get-authorize📈 view plot
⚠️ NO THRESHOLD
157.50
client-sv1-get-submit📈 view plot
⚠️ NO THRESHOLD
6,509.40
client-sv1-get-subscribe/client-sv1-get-subscribe📈 view plot
⚠️ NO THRESHOLD
277.70
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle📈 view plot
⚠️ NO THRESHOLD
730.09
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize📈 view plot
⚠️ NO THRESHOLD
590.27
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize📈 view plot
⚠️ NO THRESHOLD
206.85
🐰 View full continuous benchmarking report in Bencher

Copy link
Contributor

github-actions bot commented Oct 21, 2024

🐰 Bencher Report

Branch1232/merge
Testbedsv2

⚠️ WARNING: The following Measure does not have a Threshold. Without a Threshold, no Alerts will ever be generated!

Click here to create a new Threshold
For more information, see the Threshold documentation.
To only post results if a Threshold exists, set the --ci-only-thresholds CLI flag.

Click to view all benchmark results
BenchmarkLatencynanoseconds (ns)
client_sv2_handle_message_common📈 view plot
⚠️ NO THRESHOLD
44.15
client_sv2_handle_message_mining📈 view plot
⚠️ NO THRESHOLD
75.40
client_sv2_mining_message_submit_standard📈 view plot
⚠️ NO THRESHOLD
14.67
client_sv2_mining_message_submit_standard_serialize📈 view plot
⚠️ NO THRESHOLD
265.90
client_sv2_mining_message_submit_standard_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
582.17
client_sv2_open_channel📈 view plot
⚠️ NO THRESHOLD
149.11
client_sv2_open_channel_serialize📈 view plot
⚠️ NO THRESHOLD
291.66
client_sv2_open_channel_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
375.21
client_sv2_setup_connection📈 view plot
⚠️ NO THRESHOLD
160.56
client_sv2_setup_connection_serialize📈 view plot
⚠️ NO THRESHOLD
493.74
client_sv2_setup_connection_serialize_deserialize📈 view plot
⚠️ NO THRESHOLD
967.66
🐰 View full continuous benchmarking report in Bencher

@rrybarczyk rrybarczyk force-pushed the utils-buffer-sv2-docs branch 7 times, most recently from bf95e9b to d8c1798 Compare October 22, 2024 11:49
utils/buffer/src/slice.rs Outdated Show resolved Hide resolved
utils/buffer/src/slice.rs Outdated Show resolved Hide resolved
utils/buffer/src/slice.rs Outdated Show resolved Hide resolved
utils/buffer/src/slice.rs Outdated Show resolved Hide resolved
utils/buffer/src/slice.rs Outdated Show resolved Hide resolved
utils/buffer/src/buffer_pool/pool_back.rs Outdated Show resolved Hide resolved
utils/buffer/src/buffer_pool/pool_back.rs Outdated Show resolved Hide resolved
utils/buffer/src/buffer_pool/pool_back.rs Outdated Show resolved Hide resolved
utils/buffer/src/buffer_pool/pool_back.rs Outdated Show resolved Hide resolved
utils/buffer/examples/buffer_pool_exhaustion.rs Outdated Show resolved Hide resolved
@rrybarczyk rrybarczyk force-pushed the utils-buffer-sv2-docs branch 5 times, most recently from 74fc730 to 3137545 Compare November 5, 2024 00:45
@rrybarczyk rrybarczyk changed the title [WIP] Utils buffer sv2 docs Utils buffer sv2 docs Nov 5, 2024
@rrybarczyk rrybarczyk marked this pull request as ready for review November 5, 2024 16:09
@rrybarczyk rrybarczyk force-pushed the utils-buffer-sv2-docs branch 3 times, most recently from db7a330 to 49ac424 Compare November 5, 2024 16:12
@rrybarczyk rrybarczyk requested a review from Fi3 November 5, 2024 16:12
@plebhash
Copy link
Collaborator

plebhash commented Dec 2, 2024

@rrybarczyk I guess I said on the last call that I felt this PR was ready, but after another look I left a few extra comments

utils/buffer/README.md Show resolved Hide resolved
utils/buffer/examples/basic_buffer_pool.rs Outdated Show resolved Hide resolved
utils/buffer/README.md Outdated Show resolved Hide resolved
utils/buffer/src/buffer_pool/mod.rs Show resolved Hide resolved
utils/buffer/src/buffer_pool/mod.rs Outdated Show resolved Hide resolved
utils/buffer/src/slice.rs Show resolved Hide resolved
utils/buffer/src/slice.rs Show resolved Hide resolved
utils/buffer/src/slice.rs Show resolved Hide resolved
utils/buffer/src/slice.rs Show resolved Hide resolved
utils/buffer/src/slice.rs Show resolved Hide resolved
@rrybarczyk rrybarczyk force-pushed the utils-buffer-sv2-docs branch 2 times, most recently from ce084cf to f9a79e5 Compare December 10, 2024 00:32
@GitGab19
Copy link
Collaborator

Alright, I just cleaned up many old comments from my last review. What I left there is something which is worth resolving/answering before proceeding @rrybarczyk

@rrybarczyk rrybarczyk force-pushed the utils-buffer-sv2-docs branch 2 times, most recently from ec9e4fb to 1d95d86 Compare December 10, 2024 17:11
@rrybarczyk rrybarczyk force-pushed the utils-buffer-sv2-docs branch from 1d95d86 to 13ab37d Compare December 10, 2024 17:17
@GitGab19 GitGab19 merged commit 5bcd54d into stratum-mining:main Dec 11, 2024
38 checks passed
@plebhash plebhash mentioned this pull request Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation protocols Lowest level protocol logic util Common utilities/helpers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need Rust docs for utils::buffer
5 participants