search

lf-lang / reactor-c

A reactor runtime written in C
Other
12 stars 24 forks source link

Usage of 'fixed-size' integer types in RTI code #453

Open Jakio815 opened 4 months ago

Jakio815 commented 4 months ago

This resolves issue #449.

  1. Clarified types of federate_id, which was defined as just int not int32_t, which could make problems on 16-bit systems.

  2. Also, change the runtime clock-synchronization after initial clock-sync, to send a 2 byte uint16_t federate_id not int32_t which is 4 bytes.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!NOTE] Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits Files that changed from the base of the PR and between dc11c70c53f85720d7cd0718143e1ce8127126ad and e201df6c958fca57ee136fa342a99ad2d6ae2993.
Files selected for processing (5) * core/federated/RTI/rti_remote.c (3 hunks) * core/federated/clock-sync.c (1 hunks) * core/federated/federate.c (2 hunks) * core/utils/util.c (3 hunks) * include/core/utils/util.h (1 hunks) 
 ________________________________________________
< Press W-A-S-D to move me around your codebase. >
 ------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

Walkthrough

The changes standardize the data type used for a federate ID across multiple files, switching from int and int32_t to uint16_t. This improves consistency and prevents potential issues, particularly on 16-bit systems. Moreover, checks for the number of federates, which might exceed uint16_t limits, are removed to prevent unnecessary constraints.

Changes

File Path Change Summary
core/federated/RTI/rti_remote.c Updated message size calculation and type casting in clock synchronization thread function
core/federated/clock-sync.c Modified federate ID encoding from int to uint16_t for clock sync messages
core/federated/federate.c Removed checks for excess number of federates in connection functions
core/utils/util.c Changed _lf_my_fed_id type from int to uint16_t and updated associated logic
include/core/utils/util.h Updated _lf_my_fed_id and related functions to use uint16_t instead of int

Possibly related issues

[!TIP]

CodeRabbit can generate a title for your PR based on the changes. Add @coderabbitai placeholder anywhere in the title of your PR and CodeRabbit will replace it with a title based on the changes in the PR. You can change the placeholder by changing the `reviews.auto_title_placeholder` setting.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
lhstrh commented 4 months ago

@edwardalee?

Jakio815 commented 4 months ago

I'm still getting failures on this test, ./gradlew core:compileKotlin on Windows. Does anyone have ideas about this?

cmnrd commented 4 months ago

No, the error is really odd. It seems to be related to some caching mechanism. @lhstrh do you have any idea why this fails? Is there a way to reset the CI cache?

lhstrh commented 3 months ago

No, the error is really odd. It seems to be related to some caching mechanism. @lhstrh do you have any idea why this fails? Is there a way to reset the CI cache?

Nope. Not a Windows user... Remove the Gradle cache and try again? It looks like this PR was almost ready to merge but somehow got stuck. How do we move it forward?