Add guards against invalid file descriptors#931
Closed
joshvoigts wants to merge 1 commit intokkawakam:masterfrom
Closed
Add guards against invalid file descriptors#931joshvoigts wants to merge 1 commit intokkawakam:masterfrom
joshvoigts wants to merge 1 commit intokkawakam:masterfrom
Conversation
Collaborator
|
I would prefer to fix the root cause instead of its consequences |
Collaborator
|
Could you please give #932 a try ? |
Author
|
Sure, I'll give it a shot. It's pretty intermittent. I'll be using the library for awhile and then inexplicably hit the panic. I haven't quite narrowed down when it happens but it seems like it happens around terminal split pane resizes or maybe |
Author
|
I'm seeing what looks like another issue with #932: It could be because in some circumstances rustyline editor is reinitialized. I'll try without the assert. |
Collaborator
You should not ! Index: src/tty/unix.rs
===================================================================
diff --git a/src/tty/unix.rs b/src/tty/unix.rs
--- a/src/tty/unix.rs (revision 12ea5243e4657b2d0ceb07075cc88102b654b412)
+++ b/src/tty/unix.rs (date 1774420169850)
@@ -163,6 +163,7 @@
#[expect(unused_must_use)]
impl Drop for TtyIn {
fn drop(&mut self) {
+ debug!(target: "rustyline", "TtyIn::drop");
if let Some(sig) = self.sig.take() {
sig.uninstall_sigwinch_handler();
}
@@ -1298,6 +1299,7 @@
impl Sig {
#[cfg(not(feature = "signal-hook"))]
fn install_sigwinch_handler() -> Result<Self> {
+ debug!(target: "rustyline", "install_sigwinch_handler");
assert!(unsafe { SIG_PIPE }.is_none());
use nix::sys::signal;
let (pipe, pipe_write) = UnixStream::pair()?;
@@ -1310,6 +1312,7 @@
);
let original_sigint = unsafe { signal::sigaction(signal::SIGINT, &sa)? };
let original_sigwinch = unsafe { signal::sigaction(signal::SIGWINCH, &sa)? };
+ debug!(target: "rustyline", "install_sigwinch_handler: {pipe:?}");
Ok(Self {
pipe,
original_sigint,
@@ -1328,6 +1331,7 @@
#[cfg(not(feature = "signal-hook"))]
fn uninstall_sigwinch_handler(self) -> Result<()> {
use nix::sys::signal;
+ debug!(target: "rustyline", "uninstall_sigwinch_handler: {self.pipe:?}");
let _ = unsafe { signal::sigaction(signal::SIGINT, &self.original_sigint)? };
let _ = unsafe { signal::sigaction(signal::SIGWINCH, &self.original_sigwinch)? };
close(self.pipe)?;Make sure a logger is initialized: fn main() ... {
env_logger::init();
...And something like: RUST_LOG=rustyline=debug cargo run --example example 2> debug.log |
Author
|
Collaborator
unsafe { SIG_PIPE }.take()doesn't work as expected close(self.pipe)?; |
Collaborator
|
A minimal example to reproduce the issue: unsafe { SIG_PIPE }.take()cannot be used ! |
Collaborator
|
Could you please give #932 another try ? |
Author
|
Sorry, I didn't see you force pushed, trying, sometimes it randomly comes up, so I might try it for a few days. It's working so far. |
Author
|
I've been running #932 for a few days and it's working well for me. I'll close this pr. Appreciate the help. |
Collaborator
|
Thank for your time / feedback. |
Collaborator
|
Version 18.0.0 released |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds guards against invalid file descriptors (
-1) insrc/tty/unix.rsto prevent panics.The problem:
I was hitting this panic:
The issue seemed to come up when resizing terminal splits, and occasionally when quitting. After some digging, I found that certain code paths could end up passing an invalid file descriptor (
-1).The fix:
Add a few defensive checks.