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

Increment tag after mode switch rather than set to 1 #459

Merged
merged 2 commits into from
Jun 29, 2024

Conversation

edwardalee
Copy link
Contributor

@edwardalee edwardalee commented Jun 28, 2024

This PR fixes #458. Previously, after a mode transition, the microstep was hardwired to 1, which caused a fatal error after the mode transition when the runtime tried to advance to microstep 1 and found that it was already at microstep 1.

Summary by CodeRabbit

  • Bug Fixes
    • Improved the accuracy of mode changes processing by ensuring reactions are triggered at the appropriate microstep, enhancing the system's responsiveness and reliability.

Copy link
Contributor

coderabbitai bot commented Jun 28, 2024

Walkthrough

The changes refine the logic for microstep advancements during mode changes in modal models. By updating the dummy_event_tag to increment the current microstep instead of setting it to 1, the fix helps in appropriately triggering reactions, preventing the race condition that caused watchdog timeouts and fatal errors.

Changes

Files Change Summary
core/modal_models/… Updated _lf_process_mode_changes function to increment microstep in dummy_event_tag initialization

Sequence Diagram(s)

sequenceDiagram
    participant ModeChangeHandler
    participant Environment
    participant WatchdogScheduler
    participant Reactions
    
    ModeChangeHandler->>Environment: Get current_tag
    Environment-->>ModeChangeHandler: Return current_tag (time, microstep)
    ModeChangeHandler->>ModeChangeHandler: Increment microstep by 1
    ModeChangeHandler->>Reactions: Process mode changes
    Note right of Reactions: Ensures appropriate triggering
    WatchdogScheduler->>ModeChangeHandler: Schedule watchdog
    ModeChangeHandler->>Environment: Update tag (time, microstep)
    Environment-->>ModeChangeHandler: Confirm update
    ModeChangeHandler->>Reactions: Handle watchdog reactions
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure watchdogs function correctly in modal models (#458)
Prevent race conditions causing timeouts and fatal errors (#458)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d22db97 and 33e7c20.

Files selected for processing (1)
  • core/modal_models/modes.c (1 hunks)
Additional comments not posted (1)
core/modal_models/modes.c (1)

510-510: Proper adjustment of microstep value during mode transitions.

The modification to increment the microstep rather than setting it to a fixed value is a critical fix that addresses the fatal error described in the linked issue. This ensures that the microstep progresses correctly and uniquely, which is essential for the correct sequencing of events, especially in tightly scheduled scenarios.

Copy link
Member

@lhstrh lhstrh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks right to me!

@edwardalee edwardalee added this pull request to the merge queue Jun 29, 2024
Merged via the queue into main with commit 7f97bd9 Jun 29, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Watchdogs do not work with modal models
2 participants