-
-
Notifications
You must be signed in to change notification settings - Fork 64
[ec]: batchAffine does not use alloca anymore #579
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @mratsim, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refactors the batchAffine function within the elliptic curve cryptography module to optimize memory usage and enhance its robustness. By eliminating the use of alloca and repurposing existing data structures, it addresses potential stack-related issues and ensures correct handling of edge cases involving infinite points, contributing to a more stable and efficient cryptographic library.
Highlights
- Removal of alloca: The batchAffine function no longer uses alloca for temporary SecretBool arrays, addressing potential stack overflow issues and improving memory safety.
- Memory Optimization: Instead of allocating a separate array, the affs[i].y field is now cleverly repurposed to store the isZero flag, reducing memory footprint and avoiding unnecessary allocations.
- Introduction of zero template: A new zero template provides a clean and type-safe abstraction for accessing the isZero flag stored within affs[i].y, improving code readability and maintainability.
- Enhanced Test Coverage: A new test case has been added to t_ec_template.nim to specifically validate the batchAffine function's behavior when handling elliptic curve points at infinity, improving robustness and correctness for edge cases.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request refactors the batchAffine functions to eliminate stack allocations (alloca) by cleverly reusing a portion of the output array for temporary storage. This is a good performance optimization. The logic is correctly adjusted to handle the memory aliasing introduced by this change. A new test case is also added to validate the correct handling of points at infinity, which is crucial for this modification. The changes are solid, and I've only found a minor opportunity to improve a comment for better clarity and consistency.
| # To avoid temporaries, we store partial accumulations | ||
| # in affs[i].x | ||
| let zeroes = allocStackArray(SecretBool, N) | ||
| # in affs[i].x and affs[i].y will store if the input was 0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment is slightly inaccurate. affs[i].x is used for partial accumulations of products, while a part of affs[i].y is repurposed to store the zero flag. The comment for the batchAffine implementation for Jacobian coordinates on line 109 is more precise. For consistency and clarity, I suggest updating this comment to be more descriptive of the implementation.
# in affs[i].x. A part of `affs[i].y` is used as scratch space to store if the input was at infinity.
Fix #578, should help with status-im/nimbus-eth1#3389
Though looking at the CI, nimbus-eth1 should probably not use LTO for constantine as well.
cc @advaita-saha, @arnetheduck