iddm / thread-priority

A simple Cross-platform thread schedule and priority library for rust.
MIT License
110 stars 20 forks source link

VxWorks support #45

Closed biabbas closed 2 weeks ago

biabbas commented 1 month ago

Fixes #44

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes enhance support for the VxWorks operating system within the src/unix.rs and src/lib.rs modules. Modifications include the introduction of the SCHED_SPORADIC scheduling policy and updates to error handling functions specific to VxWorks. The RealtimeThreadSchedulePolicy enum is extended with a new Sporadic variant, and the set_thread_priority_and_policy function is adjusted for VxWorks compatibility. Additionally, the src/lib.rs file includes conditional compilation directives and updates to the ThreadPriorityValue struct to define a maximum thread priority specific to VxWorks.

Changes

File(s) Change Summary
src/unix.rs Added Sporadic variant to RealtimeThreadSchedulePolicy. Introduced errno() and set_errno() functions. Updated to_posix method to handle Sporadic. Modified set_thread_priority_and_policy to include VxWorks handling.
src/lib.rs Updated module declaration for unix to include target_os = "vxworks". Defined new MAX constant in ThreadPriorityValue struct for VxWorks. Updated error messages for ThreadPriorityValue to specify range for VxWorks.
tests/unix.rs Added support for VxWorks in multiple test functions. Duplicated get_and_set_priority_with_normal_policies for VxWorks. Maintained error handling logic for invalid priority values.

Poem

In the land of threads where bunnies play,
VxWorks hops in, brightening the day.
With policies new and errors in check,
Our library's strong, what the heck!
So let’s thread our way through the code,
With joy in our hearts, let the changes explode! 🐇✨


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 , 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 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. ### 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
biabbas commented 1 month ago

r? @iddm

biabbas commented 1 month ago

Cargo test fails for VxWorks. The max value check in lib.rs for threadpriority seems to be the problem.

[vxWorks *]# ./unix-2dd6dee514656752.vxe

running 2 tests
test get_and_set_priority_with_realtime_policy_requires_capabilities::case_1_fifo ... FAILED
test get_and_set_priority_with_realtime_policy_requires_capabilities::case_2_roundrobin ... FAILED

failures:

---- get_and_set_priority_with_realtime_policy_requires_capabilities::case_1_fifo stdout ----
thread 'get_and_set_priority_with_realtime_policy_requires_capabilities::case_1_fifo' panicked at 'called `Result::unwrap()` on an `Err` value: "The value is not in the range of [0;99]"', tests/unix.rs:158:82
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

---- get_and_set_priority_with_realtime_policy_requires_capabilities::case_2_roundrobin stdout ----
thread 'get_and_set_priority_with_realtime_policy_requires_capabilities::case_2_roundrobin' panicked at 'called `Result::unwrap()` on an `Err` value: "The value is not in the range of [0;99]"', tests/unix.rs:158:82

failures:
    get_and_set_priority_with_realtime_policy_requires_capabilities::case_1_fifo
    get_and_set_priority_with_realtime_policy_requires_capabilities::case_2_roundrobin

test result: FAILED. 0 passed; 2 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.70s
biabbas commented 1 month ago

Test results for VxWorks

[vxWorks *]# ./tests/common-a84adfa34cf086c5.vxe

running 3 tests
test should_be_impossible_to_get_other_thread_native_id_via_threadext ... ok
test should_be_possible_to_get_current_thread_native_id_via_threadext ... ok
test should_be_possible_to_reset_the_same_priority ... ok

test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.07s

[vxWorks *]# ./tests/unix-2dd6dee514656752.vxe

running 6 tests
test get_and_set_priority_with_normal_policies::policy_1_ThreadSchedulePolicy__Normal_NormalThreadSchedulePolicy__Other_::priority_1_ThreadPriority__Min ... ok
test get_and_set_priority_with_normal_policies::policy_1_ThreadSchedulePolicy__Normal_NormalThreadSchedulePolicy__Other_::priority_2_ThreadPriority__Max ... ok
test get_and_set_priority_with_normal_policies::policy_1_ThreadSchedulePolicy__Normal_NormalThreadSchedulePolicy__Other_::priority_3_ThreadPriority__Crossplatform_23u8_try_into___unwrap___ ... ok
test get_and_set_priority_with_normal_policy ... ok
test get_and_set_priority_with_realtime_policy_requires_capabilities::case_1_fifo ... ok
test get_and_set_priority_with_realtime_policy_requires_capabilities::case_2_roundrobin ... ok

test result: ok. 6 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.10s

[vxWorks *]# ./tests/thread_priority-16d21276c67c2411.vxe

running 2 tests
test unix::tests::change_between_realtime_and_normal_policies_requires_capabilities ... ok
test unix::tests::thread_schedule_policy_param_test ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.05s
biabbas commented 3 weeks ago

review? @iddm

biabbas commented 2 weeks ago

@iddm How do we get these changes into a stable release?

iddm commented 2 weeks ago

Thank you! Available in https://crates.io/crates/thread-priority/1.2.0