magicant / yash-rs

Reimplementation of yash, an extended POSIX shell
65 stars 3 forks source link

Replace SigSet with Signal array in System #368

Closed magicant closed 4 months ago

magicant commented 4 months ago

This commit replaces the SigSet type with an array of Signal in the System trait. This change is necessary because the SigSet type is specific to the nix crate, and the System trait should not depend on specific types from external crates.

This commit also updates the implementations of the System trait to reflect this change. SelectSystem::wait_mask is now an optional Vec of Signal, and virtual Process now uses a BTreeSet of Signal instead of SigSet.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes in this update focus on improving signal handling in the yash-env project. Key modifications include altering the sigmask method to use a tuple of SigmaskHow and signal numbers, replacing SigSet with Vec<signal::Number>, and updating the Process struct to use BTreeSet for managing signals. These adjustments enhance flexibility and control over signal manipulation within the system.

Changes

Files Change Summaries
yash-env/CHANGELOG.md Summarized changes in system::System and system::virtual::Process modules, updated sigmask method parameters, and modified signal handling.
yash-env/src/lib.rs Removed import of nix::sys::signal::Signal, replaced Signal::SIGCHLD with &SIGCHLD in assertions.
yash-env/src/subshell.rs Imported signal module, replaced SigSet with Vec<signal::Number>, refactored signal handling for SIGINT and SIGQUIT.
yash-env/src/system.rs Modified System and SystemEx traits, changed sigmask method parameters, updated signal handling logic, removed pub use nix::sys::signal::SigmaskHow.
yash-env/src/system/real.rs Updated sigmask method to accept op as a tuple and old_mask as a mutable reference to a vector, modified signal mask handling in pselect.
yash-env/src/system/real/signal.rs Introduced all_signals() function, added sigset_to_vec() function for converting signal sets to vectors.
yash-env/src/system/virtual.rs Updated sigmask and select methods to use tuples and slices of signal numbers instead of SigSet, restructured signal mask handling.
yash-env/src/system/virtual/process.rs Replaced SigSet with BTreeSet for managing blocked and pending signals in Process struct, updated methods to accommodate this change.
yash-env/src/system/virtual/signal.rs Removed Number struct and its methods for converting signal numbers between real and virtual systems.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Subshell
    participant System
    participant Signal

    User->>Subshell: block_sigint_sigquit()
    Subshell->>System: sigmask(Some((SIG_BLOCK, &[sigint, sigquit])), Some(&mut old_mask))
    System->>Signal: Retrieve signal numbers
    Signal-->>System: Return signal numbers
    System-->>Subshell: Block signals and update old_mask
    Subshell-->>User: Return success/failure

Possibly related issues

Poem

In the land of code, where signals play, A rabbit hops, clearing the way. From SigSet to vectors, changes unfold, Enhancing the system, making it bold. With signals now managed, clear and precise, The code runs smoother, a paradise. 🐇✨


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