Use arch-specific deflate_quick functions instead of compare256. #1847

nmoinvaz · 2025-01-05T00:13:40Z

Summary by CodeRabbit

Release Notes

New Features
- Added optimized quick deflation functionality across multiple architectures (SSE2, AVX2, ARM NEON, RISC-V)
Performance Improvements
- Introduced architecture-specific quick deflation methods for enhanced compression efficiency
- Expanded support for different CPU instruction sets
Technical Updates
- Refactored deflation implementation with new template-based approach
- Updated function tables and configuration to support new quick deflation methods

coderabbitai · 2025-01-05T00:13:47Z

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces significant changes to the zlib library's deflation process, focusing on optimizing quick deflation across different architectures. The modifications involve adding a new template header deflate_quick_tpl.h, removing the existing deflate_quick.c, and updating function declarations and macro definitions across multiple architecture-specific files. The changes aim to provide a more flexible and architecture-optimized approach to quick deflation, with specific implementations for ARM NEON, x86 (SSE2 and AVX2), RISC-V, and generic C implementations.

Changes

File	Change Summary
`CMakeLists.txt`	Added `deflate_quick_tpl.h` as private header, removed `deflate_quick.c`
`arch//compare256_.c`	Added `DEFLATE_QUICK` macro for architecture-specific implementations (ARM, x86, RISC-V)
`arch/generic/generic_functions.h`	Added `deflate_quick_c` function declaration and `native_deflate_quick` macro
`arch/x86/x86_functions.h`	Added `deflate_quick_sse2` and `deflate_quick_avx2` function declarations
`deflate.c`	Renamed `deflate_quick` to `deflate_quick_stub`
`deflate_quick_tpl.h`	Added header guard, updated function signature
`functable.c`	Added `deflate_quick_stub`, removed `compare256` function pointer
`functable.h`	Added `deflate_quick` function pointer to `functable_s` structure

Sequence Diagram

sequenceDiagram
    participant Init as Initialization
    participant FuncTable as Function Table
    participant Arch as Architecture-Specific Implementation
    participant Deflate as Deflation Process

    Init->>FuncTable: Initialize function table
    FuncTable->>Arch: Select optimal deflate_quick implementation
    Arch-->>FuncTable: Return architecture-specific function
    Deflate->>FuncTable: Request quick deflation
    FuncTable->>Arch: Call selected implementation
    Arch-->>Deflate: Return compression result

Possibly related PRs

Use GCC's may_alias attribute for unaligned memory access #1548: Changes align with performance improvements in memory access and deflation optimization

Suggested labels

optimization, Build Env

Suggested reviewers

KungFuJesus
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 787c7f6 and eaaf6a9.

📒 Files selected for processing (13)

CMakeLists.txt (1 hunks)
arch/arm/compare256_neon.c (1 hunks)
arch/generic/compare256_c.c (1 hunks)
arch/generic/generic_functions.h (2 hunks)
arch/power/compare256_power9.c (1 hunks)
arch/riscv/compare256_rvv.c (1 hunks)
arch/x86/compare256_avx2.c (1 hunks)
arch/x86/compare256_sse2.c (1 hunks)
arch/x86/x86_functions.h (4 hunks)
deflate.c (2 hunks)
deflate_quick_tpl.h (4 hunks)
functable.c (9 hunks)
functable.h (1 hunks)

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>, 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. (Beta)
@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.

nmoinvaz · 2025-01-05T00:21:37Z

Closing. After refining my benchmark, it showed little to no improvement after all and a 2K library size increase.

DEVELOP

OS: Windows 11 10.0.26100 AMD64
CPU: Intel64 Family 6 Model 198 Stepping 2, GenuineIntel
Tool: ../zlib-ng/build/Release/minigzip.exe Size: 110,080 B
Levels: 0-1
Runs: 70         Trim worst: 40

 Level   Comp   Comptime min/avg/max/stddev  Decomptime min/avg/max/stddev  Compressed size
 0    100.008%      0.111/0.116/0.118/0.002        0.108/0.110/0.112/0.001      211,973,953
 1     44.409%      0.654/0.661/0.665/0.003        0.323/0.327/0.329/0.002       94,127,497

 avg1  72.208%                        0.388                          0.218
 avg2 144.416%                        0.777                          0.437
 tot                                 23.299                         13.102      306,101,450

PR

OS: Windows 11 10.0.26100 AMD64
CPU: Intel64 Family 6 Model 198 Stepping 2, GenuineIntel
Tool: ../zlib-ng/build/Release/minigzip-quick.exe Size: 112,128 B
Levels: 0-1
Runs: 70         Trim worst: 40

 Level   Comp   Comptime min/avg/max/stddev  Decomptime min/avg/max/stddev  Compressed size
 0    100.008%      0.109/0.115/0.119/0.002        0.107/0.110/0.111/0.001      211,973,953
 1     44.409%      0.659/0.662/0.664/0.001        0.324/0.329/0.330/0.002       94,127,497

 avg1  72.208%                        0.389                          0.219
 avg2 144.416%                        0.778                          0.438
 tot                                 23.325                         13.146      306,101,450

codecov · 2025-01-05T00:34:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.64%. Comparing base (787c7f6) to head (eaaf6a9).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1847      +/-   ##
===========================================
- Coverage    82.19%   81.64%   -0.55%     
===========================================
  Files          138      129       -9     
  Lines        10985    10433     -552     
  Branches      2695     2716      +21     
===========================================
- Hits          9029     8518     -511     
+ Misses        1261     1234      -27     
+ Partials       695      681      -14

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

Use arch-specific deflate_quick functions instead of compare256.

eaaf6a9

nmoinvaz closed this Jan 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Use arch-specific deflate_quick functions instead of compare256. #1847

Use arch-specific deflate_quick functions instead of compare256. #1847

Uh oh!

nmoinvaz commented Jan 5, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 5, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

nmoinvaz commented Jan 5, 2025

Uh oh!

codecov bot commented Jan 5, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Use arch-specific deflate_quick functions instead of compare256. #1847

Use arch-specific deflate_quick functions instead of compare256. #1847

Uh oh!

Conversation

nmoinvaz commented Jan 5, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

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

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram

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!

nmoinvaz commented Jan 5, 2025

DEVELOP

PR

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

nmoinvaz commented Jan 5, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 5, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jan 5, 2025 •

edited

Loading