Match function declaration for chorba_small_nondestructive_sse2 #1907

pps83 · 2025-04-26T19:05:26Z

Summary by CodeRabbit

Refactor
- Improved function parameter const-correctness for enhanced data safety.
- Updated function declarations to standardize linkage specifications.

coderabbitai · 2025-04-26T19:05:37Z

Walkthrough

This change updates function declarations in two x86 architecture-specific source files. In both arch/x86/chorba_sse2.c and arch/x86/chorba_sse41.c, the extern keyword is removed from the declaration of the crc32_braid_base function, converting it to a standard function prototype. Additionally, in arch/x86/chorba_sse41.c, the chorba_small_nondestructive_sse2 function signature is updated to take a pointer to constant data for its buffer parameter, enforcing const-correctness. No logic, control flow, or error handling is affected.

Changes

File(s)	Change Summary
arch/x86/chorba_sse2.c, arch/x86/chorba_sse41.c	Removed `extern` from the `crc32_braid_base` function declaration, making it a normal prototype.
arch/x86/chorba_sse41.c	Changed `chorba_small_nondestructive_sse2` second parameter from `uint64_t ` to `const uint64_t `.

Possibly related PRs

SSE4.1 optimized chorba #1893: Introduces the SSE4.1 optimized chorba implementation and modifies related function declarations, including those updated in this PR.
Explicit SSE2 vectorization of Chorba CRC method #1872: Adds and modifies the implementation and declarations of functions such as crc32_braid_base in the same files, focusing on explicit SSE2 vectorization.
Chorba #1837: Refactors and reorganizes CRC32 braid-related functions, including crc32_braid_base, and touches the same function declarations and linkage.

Suggested labels

Architecture

Suggested reviewers

Dead2

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 46fc33f and 8fdf6d5.

📒 Files selected for processing (2)

arch/x86/chorba_sse2.c (1 hunks)
arch/x86/chorba_sse41.c (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

arch/x86/chorba_sse41.c (3)

Learnt from: KungFuJesus
PR: zlib-ng/zlib-ng#1872
File: arch/x86/chorba_sse2.c:0-0
Timestamp: 2025-02-21T01:42:40.488Z
Learning: In the SSE2-optimized Chorba CRC implementation (chorba_small_nondestructive_sse), the input buffer length is enforced to be a multiple of 16 bytes due to SSE2 operations, making additional checks for smaller alignments (like 8 bytes) redundant.

Learnt from: Dead2
PR: zlib-ng/zlib-ng#1837
File: arch/generic/crc32_c.c:19-29
Timestamp: 2025-01-23T22:01:53.422Z
Learning: The Chorba CRC32 functions (crc32_chorba_118960_nondestructive, crc32_chorba_32768_nondestructive, crc32_chorba_small_nondestructive, crc32_chorba_small_nondestructive_32bit) are declared in crc32_c.h.

Learnt from: KungFuJesus
PR: zlib-ng/zlib-ng#1872
File: arch/x86/chorba_sse2.c:14-24
Timestamp: 2025-02-21T01:41:50.358Z
Learning: In zlib-ng's SSE2 vectorized Chorba CRC implementation, the code that calls READ_NEXT macro ensures 16-byte alignment, making explicit alignment checks unnecessary within the macro.

⏰ Context from checks skipped due to timeout of 90000ms (19)

GitHub Check: Ubuntu GCC AARCH64
GitHub Check: Ubuntu GCC
GitHub Check: Ubuntu GCC AARCH64
GitHub Check: Ubuntu Clang No Optim
GitHub Check: Ubuntu Clang
GitHub Check: Ubuntu Clang No Threads
GitHub Check: Ubuntu GCC
GitHub Check: Ubuntu GCC Symbol Prefix
GitHub Check: Ubuntu GCC ARM HF
GitHub Check: Ubuntu GCC MIPS64
GitHub Check: Ubuntu GCC PPC64LE
GitHub Check: Ubuntu GCC AARCH64
GitHub Check: Ubuntu GCC -m32
GitHub Check: Ubuntu GCC PPC
GitHub Check: Ubuntu GCC MIPS
GitHub Check: Ubuntu GCC
GitHub Check: Analyze (cpp)
GitHub Check: Fuzzing
GitHub Check: Clang

🔇 Additional comments (3)

arch/x86/chorba_sse2.c (1)

12-12: Good removal of extern keyword

The removal of the extern keyword from the crc32_braid_base declaration turns it from an external linkage declaration to a standard function prototype within this translation unit. This change is consistent with the similar modification in arch/x86/chorba_sse41.c.

arch/x86/chorba_sse41.c (2)

13-13: Good removal of extern keyword

The removal of the extern keyword from the crc32_braid_base declaration turns it from an external linkage declaration to a standard function prototype within this translation unit. This change is consistent with the similar modification in arch/x86/chorba_sse2.c.

14-14: Great const-correctness improvement

Adding const qualifier to the aligned_buf parameter in chorba_small_nondestructive_sse2 enforces that the function doesn't modify the input buffer, which is consistent with the function's actual behavior. This improves:

Code clarity and self-documentation

Compiler optimization opportunities

Type safety by allowing direct use with const data

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
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/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-04-26T19:15:47Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.95%. Comparing base (46fc33f) to head (8fdf6d5).
Report is 3 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1907      +/-   ##
===========================================
+ Coverage    81.93%   81.95%   +0.01%     
===========================================
  Files          146      146              
  Lines        13269    13269              
  Branches      2944     2944              
===========================================
+ Hits         10872    10874       +2     
- Misses        1450     1489      +39     
+ Partials       947      906      -41

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

KungFuJesus

LGTM

Dead2

LGTM

Match function declaration for chorba_small_nondestructive_sse2

f34b187

Remove unnecessary extern

8fdf6d5

KungFuJesus approved these changes Apr 27, 2025

View reviewed changes

Dead2 approved these changes Apr 27, 2025

View reviewed changes

Dead2 merged commit dd15e04 into zlib-ng:develop Apr 28, 2025
137 of 142 checks passed

pps83 deleted the chobra-decl branch April 28, 2025 19:55

Dead2 mentioned this pull request Nov 5, 2025

2.3.0 RC1 #1994

Merged

This was referenced Nov 12, 2025

Reorganize Chorba activation and refactor Chorba dispatch #2003

Closed

Reorganize Chorba activation #2004

Merged

Rewrite chorba dispatch functions #2006

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Match function declaration for chorba_small_nondestructive_sse2 #1907

Match function declaration for chorba_small_nondestructive_sse2 #1907

Uh oh!

pps83 commented Apr 26, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 26, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Apr 26, 2025 •

edited

Loading

Uh oh!

KungFuJesus left a comment

Uh oh!

Dead2 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Match function declaration for chorba_small_nondestructive_sse2 #1907

Match function declaration for chorba_small_nondestructive_sse2 #1907

Uh oh!

Conversation

pps83 commented Apr 26, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Apr 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

KungFuJesus left a comment

Choose a reason for hiding this comment

Uh oh!

Dead2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pps83 commented Apr 26, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Apr 26, 2025 •

edited

Loading