The primary reason is to fix an issue that occurs when an element is removed from the khash data during the `KHASH_FOREACH()` loop. If the value of `kh_end()` becomes smaller than `k` during the loop, it will repeat a meaningless internal loop until an integer overflow occurs.
Summary of Changes
Hello @dearblue, 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 introduces a new macro, kh_is_end(), to enhance the safety and correctness of iterating over khash data structures. By integrating this macro into the KHASH_FOREACH() loop, it effectively prevents an infinite loop scenario that could arise when elements are removed from the hash during iteration, ensuring stable and predictable behavior of hash traversals.
Highlights
- New Macro
kh_is_end(): A new macrokh_is_end(h, i)has been introduced ininclude/mruby/khash.h. This macro checks if the current iteratorihas reached or exceeded the end of the khashh, providing a robust way to determine loop termination. - Fix for
KHASH_FOREACH()Loop Issue: TheKHASH_FOREACH()macro has been updated to utilize the newkh_is_end()macro for its loop termination condition. This change addresses a critical issue where removing elements from a khash during iteration could causekh_end()to become smaller than the current iteratork, leading to an infinite loop and potential integer overflow.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| 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 pull request 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. โฉ
| #define kh_value(name, h, x) (kh_vals_##name(h)[x]) | ||
| #define kh_begin(h) (khint_t)(0) | ||
| #define kh_end(h) ((h)->n_buckets == 0 ? (h)->size : (h)->n_buckets) | ||
| #define kh_is_end(h, i) ((i) >= kh_end(h)) |