Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix quitting issue again #1876

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

malucard
Copy link
Contributor

@malucard malucard commented Mar 3, 2025

In the other PR I fixed the signal handler, but I missed that it only caught signals when the emulation was paused, so here I moved the flag to the system class and made it turn off m_running, now it works as expected

Copy link
Contributor

coderabbitai bot commented Mar 3, 2025

Warning

Rate limit exceeded

@malucard has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 11 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9b726af and fce821d.

📒 Files selected for processing (2)
  • src/core/system.h (3 hunks)
  • src/main/main.cc (3 hunks)

Walkthrough

This pull request introduces a termination mechanism for the system. A new boolean flag m_terminating is added to the System class alongside methods to check and set its state. The resume() function now prevents resumption when termination is in progress, and a new terminateSignalSafe() method correctly adjusts the running state. In the main function, signal handlers are simplified by delegating to a new handleSignal function, which uses the updated termination process to centrally manage shutdown behavior.

Changes

File(s) Summary
src/core/system.h - Added bool m_terminating = false; member variable.
- Added public method terminating() to check the termination state.
- Added terminateSignalSafe() to update termination state.
- Modified resume() to check m_terminating.
src/main/main.cc - Introduced a new function handleSignal to encapsulate signal handling logic for termination.
- Updated signal handlers to use handleSignal.
- Main loop checks termination via terminating().

Sequence Diagram(s)

sequenceDiagram
  participant OS as Operating System
  participant Main as Main Function
  participant System as System Class

  OS->>Main: SIGINT/SIGTERM Received
  Main->>Main: Call handleSignal(signal)
  Main->>System: system->terminateSignalSafe()
  System->>System: Set m_terminating = true, m_running = false
  Main->>System: Check terminating() in resume()
  System-->>Main: Returns true
Loading

Possibly related PRs

  • Fix quitting freeze #1875: Modifications in signal handling and termination logic, aligning with the controlled shutdown process using terminateSignalSafe().

Suggested reviewers

  • nicolasnoble

Poem

I'm a rabbit, quick to code,
Hopping through system modes,
When signals knock upon our door,
I set the flag and close the door,
With a wink and a hop so grand,
Our code flows smooth across the land!
🐇✨


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

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
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 (1)
src/main/main.cc (1)

169-171: Well-designed signal handler function.

This centralized signal handler function simplifies the code by providing a single place to handle termination signals, making it easier to maintain.

Consider using a more specific parameter type instead of auto:

-void handleSignal(auto signal) {
+void handleSignal(int signal) {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8df902d and 847c6c4.

📒 Files selected for processing (2)
  • src/core/system.h (3 hunks)
  • src/main/main.cc (3 hunks)
🔇 Additional comments (6)
src/core/system.h (4)

169-169: Good addition of termination state accessor.

This accessor method allows checking the termination state, which complements the existing running() and quitting() methods for a more comprehensive state tracking system.


178-178: Prevents resuming during termination.

This check appropriately prevents the system from resuming if it's in a terminating state, which helps ensure clean shutdown.


183-187: Well-designed signal-safe termination method.

The implementation correctly uses a simple flag switch which is safe to use in signal handlers. The comment accurately explains the safety constraints of signal handlers, and the method properly updates both the termination state and running state.


268-268: Good initialization of termination flag.

The termination flag is properly initialized to false, consistent with other state flags in the class.

src/main/main.cc (2)

200-201: Simplified signal registration.

The signal handler registration is now cleaner and uses the dedicated function rather than lambdas, which improves readability.


461-464: Effective termination check in main loop.

This termination check ensures that signals can terminate the application regardless of whether the emulation is running or paused, effectively fixing the issue described in the PR.

Copy link

codecov bot commented Mar 3, 2025

Codecov Report

Attention: Patch coverage is 40.00000% with 9 lines in your changes missing coverage. Please review.

Project coverage is 9.25%. Comparing base (20de16c) to head (fce821d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/main/main.cc 44.44% 5 Missing ⚠️
src/core/system.h 33.33% 4 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1876   +/-   ##
=======================================
  Coverage    9.25%    9.25%           
=======================================
  Files         467      467           
  Lines      144566   144574    +8     
=======================================
+ Hits        13386    13387    +1     
- Misses     131180   131187    +7     

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

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