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

Adding support of transient federates #358

Draft
wants to merge 93 commits into
base: main
Choose a base branch
from
Draft

Conversation

ChadliaJerad
Copy link
Collaborator

This PR replaces #192, and supports the latest major refactoring of the RTI.

It implements the transient feature in the federation execution. Details of the implementation are documented in Discussion lf-lang/lingua-franca#2212.

Copy link
Contributor

@edwardalee edwardalee 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 like a great start, but I have some doubts about the concurrency handling as indicated in the comments. I will have to finish reviewing later, but I think there is enough to work with to go ahead and submit this provisional review.

core/federated/RTI/main.c Outdated Show resolved Hide resolved
core/federated/RTI/main.c Outdated Show resolved Hide resolved
core/federated/RTI/main.c Outdated Show resolved Hide resolved
core/federated/RTI/main.c Outdated Show resolved Hide resolved
result.tag = e->next_event;
return result;
}
} else if (lf_tag_compare(min_upstream_completed, e->last_granted) > 0
&& lf_tag_compare(min_upstream_completed, e->next_event) >= 0 // The enclave has to advance its tag
) {
result.tag = min_upstream_completed;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that if you just change this one line to:

Suggested change
result.tag = min_upstream_completed;
result.tag = e->next_event;

then none of your num_connected_upstream tracking and testing is necessary. As the code was originally written, if a federate has no upstream federates, it would always be granted TAG(FOREVER_TAG). But with transient federates, this is no longer OK. So think this one-line change would also make everything clearer.

Comment on lines 442 to 447
(lf_tag_compare(fed->pending_grant, NEVER_TAG) == 0)
&& (lf_tag_compare(fed->pending_provisional_grant, NEVER_TAG) >= 0)
) {
fed->pending_provisional_grant = tag;
lf_thread_create(&(fed->pending_provisional_grant_thread_id), pending_provisional_grant_thread, fed);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, I'm worried about just dropping this PTAG. Could the test failure that showed up the TS tests might be a consequence of this (not for this PTAG but for the TAG)? I bet that's a flaky test failure.

core/federated/RTI/rti_remote.c Outdated Show resolved Hide resolved
fed->requested_stop = true;
}
if (rti_remote->base.num_scheduling_nodes_handling_stop
== rti_remote->base.number_of_scheduling_nodes) {
== (rti_remote->base.number_of_scheduling_nodes - rti_remote->number_of_transient_federates)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this needs to take into account transient federates that are connected, no? Otherwise, a transient federate that is connected may be told to stop at a tag that it has already passed.

core/federated/RTI/rti_remote.c Show resolved Hide resolved
core/federated/RTI/rti_remote.c Show resolved Hide resolved
* @brief Return the directory containing the executables of the individual
* federates.
*/
char* lf_get_federates_bin_directory();
Copy link
Contributor

Choose a reason for hiding this comment

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

Exposing information about the file system location at compile time to the program seems like a pretty bad idea to me. Paths can change, binaries get deployed to other systems. If it really is needed, it should be provided as a parameter at runtime.

*
* This function is particularly useful for testing transient federates.
*/
void lf_stop();
Copy link
Contributor

Choose a reason for hiding this comment

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

If this is used for testing, should we really make it part of the public API?

include/core/federated/network/net_common.h Outdated Show resolved Hide resolved
@cmnrd
Copy link
Contributor

cmnrd commented Feb 23, 2024

In the "files changed" view, you can add suggestions to batch and commit them all at once. This way, we can avoid having lots of commit messages without a descriptive commit message.

@lhstrh
Copy link
Member

lhstrh commented Feb 23, 2024

In the "files changed" view, you can add suggestions to batch and commit them all at once. This way, we can avoid having lots of commit messages without a descriptive commit message.

You probably want to use an interactive rebase to squash or even fixup all these commits...

ChadliaJerad and others added 23 commits March 18, 2024 23:52
…bin_directory(), and lf_get_federaion_id() declarations to util.h
…ribe interface preservation checking in case of a hot swap
Copy link
Contributor

coderabbitai bot commented Jul 10, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

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.

5 participants