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

Support build cython codes with -Werror=strict-aliasing #247

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

aisk
Copy link
Member

@aisk aisk commented Mar 4, 2024

Cython does not support using * operator to dereferencing a pointer, so the old code is using [0] for this job. However, this usage can't be built with -Werror=strict-aliasing, see #246 for details.

In this PR, using memcpy to force cast a double to an int64_t to do the job. This can be built on my machine with -Werror=strict-aliasing.

Hi @eli-schwartz can you help me test it on your machine?

Close #246

Summary by CodeRabbit

  • Refactor
    • Improved handling of double values in the system to enhance performance and accuracy.

Copy link

coderabbitai bot commented Mar 4, 2024

Walkthrough

The update in thriftpy2/protocol/cybin/cybin.pyx involves refining the handling of double values by utilizing memcpy for reading and writing operations. This approach is aimed at addressing strict-aliasing rule violations that previously led to compilation issues, thus enhancing the code's compliance with C standards without compromising on performance or functionality.

Changes

Files Change Summary
.../cybin/cybin.pyx Introduced memcpy for handling double values, replacing direct casting to mitigate strict-aliasing violations.

Assessment against linked issues

Objective Addressed Explanation
Identify and resolve strict-aliasing violations in generated C code (cybin.c) (#246)
Address strict-aliasing rule violations in __pyx_f_5cybin_write_double and __pyx_f_5cybin_c_read_val (#246)
Investigate alternative methods for double value manipulation to avoid strict-aliasing violations (#246) Using memcpy is an alternative method that avoids these violations.
Ensure changes maintain functionality and performance related to double value bit manipulation (#246)
Test for compilation without strict-aliasing errors and correct function in thriftpy2 context (#246) The summary does not explicitly mention testing, but the change implies a technical solution that should address the issue.
Document changes made to address strict-aliasing violations (#246) The summary does not mention documentation of the changes.

Poem

To the rhythm of the bits, a rabbit hops and sits,
🐇💻 In the code, it found a glitch, with a twitch.
With memcpy in its kit, it made a fix so slick,
No more aliasing, so strict, a seamless stitch.
Now the code compiles, so quick, without a hitch,
Celebrate the patch, so neat, without a snitch.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between d81f47c and c3b3f5d.
Files selected for processing (1)
  • thriftpy2/protocol/cybin/cybin.pyx (4 hunks)
Additional comments: 1
thriftpy2/protocol/cybin/cybin.pyx (1)
  • 5-5: The import of memcpy from libc.string is correctly added to support the new approach for handling double values, aligning with the PR's objectives.

Comment on lines +103 to +105
cdef int64_t v
memcpy(&v, &val, 8)
v = htobe64(v)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of memcpy in write_double correctly addresses the strict-aliasing violation by safely copying the double value. It's a good practice to add a brief comment explaining the reason behind using memcpy here, for the benefit of future maintainers.

+    # Using memcpy to comply with strict-aliasing rules
     memcpy(&v, &val, 8)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
cdef int64_t v
memcpy(&v, &val, 8)
v = htobe64(v)
cdef int64_t v
# Using memcpy to comply with strict-aliasing rules
memcpy(&v, &val, 8)
v = htobe64(v)

Comment on lines +294 to +295
memcpy(&double_value, &n, 8)
return double_value
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of memcpy for handling T_DOUBLE in c_read_val is correctly implemented to avoid strict-aliasing violations. Consider adding a comment here as well, explaining the use of memcpy for future code maintainers.

+    # Using memcpy to safely convert int64_t to double, adhering to strict-aliasing rules
     memcpy(&double_value, &n, 8)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
memcpy(&double_value, &n, 8)
return double_value
# Using memcpy to safely convert int64_t to double, adhering to strict-aliasing rules
memcpy(&double_value, &n, 8)
return double_value

@eli-schwartz
Copy link

Hi @eli-schwartz can you help me test it on your machine?

The change itself compiles fine. I don't think much of the chatbot's ineffectual analysis though.

@aisk aisk merged commit b1187ba into Thriftpy:master Mar 5, 2024
8 checks passed
@aisk aisk deleted the strict-aliasing branch March 5, 2024 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build fails with strict-aliasing violations
3 participants