Safer wrapping for FFI clients. #2906
Open
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
nihohit
force-pushed
the
pointers
branch
2 times, most recently
from
2a0e1fa to
f0dd565
Compare
Use `Arc` instead of `Box` to wrap the `ClientAdapter`, so that the lifetime of the adapter will be extended even in cases where the client is closed during commands. This also saves on using `as usize` conversions to the pointer, which cause provenance to be lost and might lead to undefined behavior. Signed-off-by: Shachar Langbeheim <[email protected]>
jonathanl-bq
reviewed
Jan 4, 2025
jonathanl-bq
reviewed
Jan 4, 2025
go/src/lib.rs
Outdated
| @@ -512,7 +515,8 @@ fn valkey_value_to_command_response(value: Value) -> RedisResult<CommandResponse | |||
| /// | |||
| /// # Safety | |||
| /// | |||
| /// * TODO: finish safety section. | |||
| /// This function should only be called, and should complete and call one of the response callbacks before `close_client` is called. | |||
There was a problem hiding this comment.
Same here. I don't know what "should only be called" means. Is there something else that can be done with the function?
There was a problem hiding this comment.
you're right, the doc was missing "once".
Co-authored-by: jonathanl-bq <[email protected]> Signed-off-by: Shachar Langbeheim <[email protected]>
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
Arcinstead ofBoxto wrap theClientAdapter, so that the lifetime of the adapter will be extended even in cases where the client is closed during commands. This also saves on usingas usizeconversions to the pointer, which cause provenance to be lost and might lead to undefined behavior.The memory cost of this change is increasing the allocation of the client by one pointer size, and the runtime cost is 4 atomic increments/decrements per command.
Checklist
Before submitting the PR make sure the following are checked: