Add public API WriteWithCallback to support custom callbacks
#12603
+203
−62
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
anand1976
reviewed
May 2, 2024
Yeah, that's a good question. |
Yeah, |
anand1976
reviewed
May 2, 2024
Thank you for the quick review! |
jowlyzhang
force-pushed
the
cb_after_wal_writes
branch
from
9fce675
to
477b6b5
Compare
jowlyzhang
changed the title
WriteWithCallback to support custom callbacks
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.
This PR adds a
DB::WriteWithCallbackAPI that does the same things asDB::Writewhile takes an argumentUserWriteCallbackto execute custom callback functions during the write.We currently support two types of callback functions:
OnWriteEnqueuedandOnWalWriteFinish. The former is invoked after the write is enqueued, and the later is invoked after WAL write finishes when applicable.These callback functions are intended for users to use to improve synchronization between concurrent writes, their execution is on the write's critical path so it will impact the write's latency if not used properly. The documentation for the callback interface mentioned this and suggest user to keep these callback functions' implementation minimum.
Although transaction interfaces' writes doesn't yet allow user to specify such a user write callback argument, the
DBImpl::Write*type of APIs do not differentiate between regular DB writes or writes coming from the transaction layer when it comes to supporting thisUserWriteCallback. These callbacks works for all the write modes including: default write mode, Options.two_write_queues, Options.unordered_write, Options.enable_pipelined_writeTest plan:
Added unit test in ./write_callback_test