Skip to content

Fix: Allow string values for realtime_mlock overcommit option#7

Open
mcasquer wants to merge 1 commit intomasterfrom
realtime-mlock-overcommit-string
Open

Fix: Allow string values for realtime_mlock overcommit option#7
mcasquer wants to merge 1 commit intomasterfrom
realtime-mlock-overcommit-string

Conversation

@mcasquer
Copy link
Owner

@mcasquer mcasquer commented Jun 4, 2025

The realtime_mlock parameter's overcommit option in qemu_vm.py was previously restricted to boolean values. This change updates the code to allow string values as well, such as "on-fault".

This provides more flexibility in configuring memory locking options for QEMU virtual machines. Boolean values will continue to be supported.

The `realtime_mlock` parameter's `overcommit` option in `qemu_vm.py`
was previously restricted to boolean values. This change updates the
code to allow string values as well, such as "on-fault".

This provides more flexibility in configuring memory locking options
for QEMU virtual machines. Boolean values will continue to be supported.
@coderabbitai
Copy link

coderabbitai bot commented Jun 4, 2025

Walkthrough

The update modifies the type annotation for the "mem-lock" attribute under the "overcommit" QEMU option from bool to None within the internal logic of the make_create_command method in virttest/qemu_vm.py. No changes are made to public interfaces or exported entities.

Changes

File(s) Change Summary
virttest/qemu_vm.py Changed "mem-lock" type annotation from bool to None in "overcommit" option handling logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VM
    participant DevicesContainer

    User->>VM: make_create_command(realtime_mlock)
    VM->>DevicesContainer: supports("overcommit")
    alt overcommit supported
        VM->>VM: Add "mem-lock" attribute with type None under "overcommit"
    else overcommit not supported
        VM->>VM: Add "mlock" attribute with type bool under "realtime"
    end
Loading
✨ Finishing Touches
  • 📝 Generate Docstrings

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

@mcasquer mcasquer marked this pull request as ready for review June 4, 2025 07:34
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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
virttest/qemu_vm.py (1)

3159-3166: Allow string values for realtime_mlock overcommit option
Changing the vtype to None in the attr_info tuple correctly bypasses the boolean-only branch in _add_option, enabling arbitrary string values like "on-fault". Please add or update unit tests to cover both boolean and string inputs for realtime_mlock when devices.has_option("overcommit") is true.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b2d3808 and f78f559.

📒 Files selected for processing (1)
  • virttest/qemu_vm.py (1 hunks)

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.

1 participant