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 adaptive scheduler #463

Merged
merged 3 commits into from
Jul 2, 2024
Merged

Fix adaptive scheduler #463

merged 3 commits into from
Jul 2, 2024

Conversation

petervdonovan
Copy link
Contributor

@petervdonovan petervdonovan commented Jul 2, 2024

As a reminder, the adaptive scheduler is a scheduler that, at least when it was created, either matched or outperformed our other schedulers in our benchmarks. Maybe we have too many schedulers, and maybe we should remove it, but this is the reason why we have it in our code base. See the graph here; the green line labeled "C heuristic" is the adaptive scheduler.

This fixes two serious bugs in the adaptive scheduler. In one bug, casting and pointer arithmetic are done in the wrong order. In the other bug, the level is advanced even if, in the process of waiting for the level to be ready to advance, more reactions were injected onto the reaction queue.

It seems like the adaptive scheduler may not have kept up with updates to federated execution in the past year.

Summary by CodeRabbit

  • Bug Fixes

    • Improved stability by adjusting the control flow in the termination function to ensure proper cleanup.
    • Enhanced assertions and type handling in the scheduler to prevent runtime errors.
  • Refactor

    • Refined pointer arithmetic and type casting in scheduler functions for better code maintainability.

Also, fix some bad asserts that only cause problems in debug mode.
Copy link
Contributor

coderabbitai bot commented Jul 2, 2024

Walkthrough

The changes involve adjustments to the control flow and type handling within two core files: reactor_common.c and scheduler_adaptive.c. In reactor_common.c, the order of function calls within the termination function has been updated for cleaner reactor cleanup. Meanwhile, scheduler_adaptive.c improvements include type casting for assertions, pointer arithmetic adjustments, and introducing a new variable for better control over level advancement based on reaction counts.

Changes

File Change Summary
core/reactor_common.c Relocated the call to lf_tracing_global_shutdown() after reactor cleanup within the termination function.
core/threaded/scheduler_adaptive.c Adjusted type casting in assertions, pointer arithmetic in get_reaction function, and added total_num_reactions variable for controlling level advancement.

Sequence Diagram(s)

sequenceDiagram
    participant Reactor
    participant Tracing as lf_tracing_global_shutdown()
    
    note over Reactor: Old Flow
    Reactor->>+Tracing: Initiate Shutdown
    Reactor->>Reactor: Cleanup Reactors
    Reactor-->>-Tracing: Complete
    
    note over Reactor: New Flow
    Reactor->>Reactor: Cleanup Reactors
    Reactor->>+Tracing: Initiate Shutdown
    Reactor-->>-Tracing: Complete
Loading

This diagram outlines the changes in the control flow for the termination function in reactor_common.c, illustrating how the reactor cleanup now occurs before the call to lf_tracing_global_shutdown().

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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 4f8ea7d and 642ceed.

Files selected for processing (2)
  • core/reactor_common.c (2 hunks)
  • core/threaded/scheduler_adaptive.c (6 hunks)
Files not reviewed due to errors (1)
  • core/reactor_common.c (no review received)
Additional comments not posted (5)
core/threaded/scheduler_adaptive.c (5)

137-137: LGTM!

The type casting to long long in the assertion ensures proper type handling.


227-227: LGTM!

The adjustment in pointer arithmetic improves readability.


241-243: LGTM!

The type casting to long long in the assertions ensures proper type handling.


Line range hint 428-450: LGTM!

The introduction of total_num_reactions and the logic modifications improve the handling of level advancement based on the number of reactions.


605-605: LGTM!

The changes to handle jitter improve the flexibility and robustness of the function.

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 642ceed and d208dda.

Files selected for processing (1)
  • core/threaded/scheduler_adaptive.c (6 hunks)
Files skipped from review as they are similar to previous changes (1)
  • core/threaded/scheduler_adaptive.c

Copy link
Contributor

@cmnrd cmnrd left a comment

Choose a reason for hiding this comment

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

Looks good!

@cmnrd cmnrd merged commit 38294a3 into main Jul 2, 2024
29 checks passed
@cmnrd cmnrd deleted the fix-adaptive-scheduler branch July 2, 2024 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants