Skip to content

Conversation

generall
Copy link
Member

@generall generall commented Jul 21, 2025

MmapHashMap had a problem with Entry alightment, in case if key value was u128. It required 16bit alightment, but
storage assumed, apparently, that nothing can need more than 8 bit alignment.

This PR introduces 2 unit tests + fix.
Fix is another alignment block inside MmapHashmap. If Required alignment is <8, there are no change and format exactly same as before. If required alignment >8, we put extra empty bytes before bucket offsets, so that
(new_alignment + buckets) % ALIGNMENT = 0.

Compatibility: luckily (thanks to @xzfc) bucket offset is stored explicitly in the header of the file.
So the same code should be able to read both: files with and without offset, even if old files were created for u128 key.

@generall generall requested a review from xzfc July 21, 2025 23:12
@generall generall marked this pull request as ready for review July 21, 2025 23:13
@generall generall requested a review from coszio July 21, 2025 23:15
Copy link
Contributor

coderabbitai bot commented Jul 21, 2025

📝 Walkthrough

"""

Walkthrough

The changes span three main areas. In lib/collection/src/collection/mmr/lazy_matrix.rs, the import of VectorStorage is now conditional on debug builds, restricting its inclusion to debug-only code. In lib/common/common/src/mmap_hashmap.rs, the file layout and creation logic are updated to include explicit alignment before the buckets section, error handling for u128 key deserialization is improved, and new tests for u128 keys and values are added. In lib/segment/src/index/field_index/map_index/mod.rs, a new test is introduced to verify the handling of UUID-based payload indices, particularly focusing on the payload_blocks method.

Estimated code review effort

2 (~20 minutes)

Possibly related PRs

  • [mmr] compute similarities lazily #6877: Introduces the LazyMatrix struct and its use of VectorStorage in the same file where the conditional import change is made, directly connecting to the updated import logic.

Suggested reviewers

  • coszio
    """

📜 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 f31acf4 and 2f6f452.

📒 Files selected for processing (1)
  • lib/common/common/src/mmap_hashmap.rs (8 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • lib/common/common/src/mmap_hashmap.rs
✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

coszio
coszio previously approved these changes Jul 21, 2025
@coszio coszio dismissed their stale review July 22, 2025 00:11

Old files without this fix create a panic on startup, which initializes the shard as dummy

ERROR qdrant::startup: Panic occurred in file lib/common/common/src/mmap_hashmap.rs at line 473: Error reading u128 from mmap: The conversion failed because the address of the source is not a multiple of the alignment of the destination type.

Source type: &[u8]
Source address: 0x11cff0728 (a multiple of 8)
Destination type: u128
Destination alignment: 16
@generall
Copy link
Member Author

Old files without this fix create a panic on startup, which initializes the shard as dummy

this is not a new behavior, but it is a behavior of the debug build. Previous version also paniked, now it will panic(in debug) earlier, and print error messages in production.

@xzfc
Copy link
Contributor

xzfc commented Jul 22, 2025

Also, not related to this particular PR, but it's better not to bake align_of into on-disk structures: align_of is platform and compiler version dependent. See https://blog.rust-lang.org/2024/03/30/i128-layout-update/.

I.e., in lib/common/common/src/mmap_hashmap.rs:

 impl Key for u128 {
-    const ALIGN: usize = align_of::<u128>();
+    const ALIGN: usize = size_of::<u128>();

@generall generall requested review from xzfc and coszio July 22, 2025 08:39
@generall generall merged commit 6fdf445 into dev Jul 22, 2025
21 of 22 checks passed
@generall generall deleted the fix-uuid-mmap-index branch July 22, 2025 18:26
generall added a commit that referenced this pull request Jul 24, 2025
* reproduce bug as unit test

* reproduce in even faster unit test

* fix alignment in mmap_hashmap

* clippy

* review fixes
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.

3 participants