Skip to content

Improved setting of OPTIMAL_CMP on ARM#1835

Merged
Dead2 merged 1 commit intozlib-ng:developfrom
ccawley2011:arm-optimal-cmp
Dec 23, 2024
Merged

Improved setting of OPTIMAL_CMP on ARM#1835
Dead2 merged 1 commit intozlib-ng:developfrom
ccawley2011:arm-optimal-cmp

Conversation

@ccawley2011
Copy link
Copy Markdown
Contributor

@ccawley2011 ccawley2011 commented Dec 22, 2024

Following the suggestion in #1830 (comment), this PR explicitly sets OPTIMAL_CMP to 8 on ARM when unaligned memory access is unavailable. I've also changed the feature checks to better cover non-GCC compilers.

On ARM32, -mno-unaligned-access can be used to force alignment-safe loads, while -mstrict-align can be used with AArch64. This should help when running benchmarks on platforms that normally have it enabled.

Summary by CodeRabbit

  • New Features
    • Enhanced the flexibility of architecture-specific optimizations for comparison sizes.
    • Improved the conditions for defining optimal comparison sizes on ARM architectures.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 22, 2024

Walkthrough

The pull request modifies the zbuild.h header file, specifically focusing on the OPTIMAL_CMP macro definition for ARM architectures. The changes expand the conditions for defining this macro by introducing additional checks for _WIN32 and __ARM_FEATURE_UNALIGNED. These modifications aim to provide a more flexible and comprehensive approach to determining the optimal comparison size across different ARM-based environments, ensuring a fallback to 8 bytes when no specific conditions are met.

Changes

File Change Summary
zbuild.h Modified OPTIMAL_CMP macro definition for ARM architectures (__aarch64__ and __arm__) with additional conditional checks

Possibly related PRs

Suggested labels

Build Env, Architecture

Suggested reviewers

  • nmoinvaz

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.

Copy link
Copy Markdown
Contributor

@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.

Actionable comments posted: 0

🧹 Nitpick comments (2)
zbuild.h (2)

252-256: LGTM! Well-structured conditional optimization for AArch64

The implementation correctly handles both unaligned access capabilities and Windows platform specifics. The OPTIMAL_CMP values are appropriately set based on the architecture's capabilities:

  • 64 bytes when unaligned access is supported (optimal for modern AArch64)
  • 8 bytes as a safe fallback when strict alignment is required

Consider documenting that on AArch64 platforms where strict alignment is enforced (OPTIMAL_CMP=8), the -mstrict-align compiler flag should be used to ensure consistent behavior.


257-262: LGTM! Appropriate optimization values for ARM32

The implementation mirrors the AArch64 structure with values adjusted for 32-bit architecture:

  • 32 bytes when unaligned access is supported (optimal for ARM32)
  • 8 bytes as a safe fallback when strict alignment is required

Consider documenting that on ARM32 platforms where strict alignment is enforced (OPTIMAL_CMP=8), the -mno-unaligned-access compiler flag should be used to ensure consistent behavior.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 87d8e95 and 06131bb.

📒 Files selected for processing (1)
  • zbuild.h (1 hunks)
🔇 Additional comments (1)
zbuild.h (1)

252-262: Verify OPTIMAL_CMP usage in alignment-sensitive operations

The changes to OPTIMAL_CMP values could affect alignment-sensitive operations throughout the codebase.

✅ Verification successful

Based on the search results, I can now make a definitive assessment. The OPTIMAL_CMP values are used carefully throughout the codebase with proper alignment handling:

  1. The code uses zng_memcmp_2/4/8 wrappers that handle unaligned access safely using memcpy
  2. Memory operations in match_tpl.h check OPTIMAL_CMP values before performing operations
  3. There's a NO_UNALIGNED macro that forces OPTIMAL_CMP to 8 when unaligned access isn't safe
  4. The chunkset implementations across architectures handle alignment requirements appropriately

OPTIMAL_CMP changes are safely implemented with proper alignment handling

The codebase has robust alignment handling through:

  • Safe memory access wrappers for unaligned comparisons
  • Conditional compilation based on architecture capabilities
  • Fallback mechanisms when unaligned access isn't supported
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for alignment-sensitive operations and OPTIMAL_CMP usage

# Search for direct OPTIMAL_CMP usage
echo "=== Checking direct OPTIMAL_CMP usage ==="
rg "OPTIMAL_CMP" -B 2 -A 2

# Search for potential alignment-sensitive operations
echo "=== Checking for alignment-sensitive memory operations ==="
rg -e "memcmp|memcpy|memmove" -B 2 -A 2

# Search for alignment checks
echo "=== Checking for alignment validation code ==="
rg -e "aligned|alignment|unaligned" -B 2 -A 2

Length of output: 66498

@codecov
Copy link
Copy Markdown

codecov bot commented Dec 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.41%. Comparing base (005c2d3) to head (06131bb).
Report is 3 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1835   +/-   ##
========================================
  Coverage    82.41%   82.41%           
========================================
  Files          136      136           
  Lines        11021    11021           
  Branches      2799     2799           
========================================
  Hits          9083     9083           
- Misses        1239     1240    +1     
+ Partials       699      698    -1     

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

@Dead2
Copy link
Copy Markdown
Member

Dead2 commented Dec 22, 2024

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.

2 participants