diff --git a/Cargo.lock b/Cargo.lock index cc8a2b44..ff87fd88 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -42,9 +42,9 @@ checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" [[package]] name = "bitflags" -version = "2.6.0" +version = "2.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de" +checksum = "8f68f53c83ab957f72c32642f3868eec03eb974d1fb82e453128456482613d36" [[package]] name = "byteorder" @@ -58,6 +58,12 @@ version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" +[[package]] +name = "cfg_aliases" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd16c4719339c4530435d38e511904438d07cce7950afa3718a84ac36c10e89e" + [[package]] name = "clap" version = "3.2.25" @@ -244,12 +250,13 @@ checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" [[package]] name = "nix" -version = "0.26.4" +version = "0.28.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "598beaf3cc6fdd9a5dfb1630c2800c7acd31df7aaf0f565796fba2b53ca1af1b" +checksum = "ab2156c4fce2f8df6c499cc1c763e4394b7482525bf2a9701c9d79d215f519e4" dependencies = [ - "bitflags 1.3.2", + "bitflags 2.8.0", "cfg-if", + "cfg_aliases", "libc", ] @@ -471,7 +478,7 @@ name = "serialport" version = "4.7.0" dependencies = [ "assert_hex", - "bitflags 2.6.0", + "bitflags 2.8.0", "cfg-if", "clap", "core-foundation", diff --git a/Cargo.toml b/Cargo.toml index 65e5e02e..45e7a634 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -172,7 +172,7 @@ version = "0.4.1" version = "2.4.0" [target."cfg(unix)".dependencies.nix] -version = "0.26" +version = "0.28" features = [ "fs", "ioctl", diff --git a/src/posix/poll.rs b/src/posix/poll.rs index 36d05cb4..a4b695ad 100644 --- a/src/posix/poll.rs +++ b/src/posix/poll.rs @@ -1,7 +1,7 @@ #![allow(non_camel_case_types, dead_code)] use std::io; -use std::os::unix::io::RawFd; +use std::os::fd::AsFd; use std::slice; use std::time::Duration; @@ -12,18 +12,18 @@ use nix::sys::signal::SigSet; #[cfg(any(target_os = "linux", test))] use nix::sys::time::TimeSpec; -pub fn wait_read_fd(fd: RawFd, timeout: Duration) -> io::Result<()> { +pub fn wait_read_fd(fd: F, timeout: Duration) -> io::Result<()> { wait_fd(fd, PollFlags::POLLIN, timeout) } -pub fn wait_write_fd(fd: RawFd, timeout: Duration) -> io::Result<()> { +pub fn wait_write_fd(fd: F, timeout: Duration) -> io::Result<()> { wait_fd(fd, PollFlags::POLLOUT, timeout) } -fn wait_fd(fd: RawFd, events: PollFlags, timeout: Duration) -> io::Result<()> { +fn wait_fd(fd: F, events: PollFlags, timeout: Duration) -> io::Result<()> { use nix::errno::Errno::{EIO, EPIPE}; - let mut fd = PollFd::new(fd, events); + let mut fd = PollFd::new(fd.as_fd(), events); let wait = match poll_clamped(&mut fd, timeout) { Ok(r) => r, @@ -87,7 +87,8 @@ fn clamped_time_spec(duration: Duration) -> TimeSpec { #[cfg(not(target_os = "linux"))] fn poll_clamped(fd: &mut PollFd, timeout: Duration) -> nix::Result { let millis = clamped_millis_c_int(timeout); - nix::poll::poll(slice::from_mut(fd), millis) + let poll_timeout = nix::poll::PollTimeout::try_from(millis).unwrap(); + nix::poll::poll(slice::from_mut(fd), poll_timeout) } #[cfg(any(not(target_os = "linux"), test))] diff --git a/src/posix/tty.rs b/src/posix/tty.rs index 8e6caea3..ca977d50 100644 --- a/src/posix/tty.rs +++ b/src/posix/tty.rs @@ -59,7 +59,7 @@ fn close(fd: RawFd) { /// ``` #[derive(Debug)] pub struct TTYPort { - fd: RawFd, + fd: OwnedFd, timeout: Duration, exclusive: bool, port_name: Option, @@ -76,26 +76,6 @@ pub enum BreakDuration { Arbitrary(std::num::NonZeroI32), } -/// Wrapper for RawFd to assure that it's properly closed, -/// even if the enclosing function exits early. -/// -/// This is similar to the (nightly-only) std::os::unix::io::OwnedFd. -struct OwnedFd(RawFd); - -impl Drop for OwnedFd { - fn drop(&mut self) { - close(self.0); - } -} - -impl OwnedFd { - fn into_raw(self) -> RawFd { - let fd = self.0; - mem::forget(self); - fd - } -} - impl TTYPort { /// Opens a TTY device as a serial port. /// @@ -119,19 +99,20 @@ impl TTYPort { use nix::libc::{cfmakeraw, tcgetattr, tcsetattr}; let path = Path::new(&builder.path); - let fd = OwnedFd(nix::fcntl::open( + let raw_fd = nix::fcntl::open( path, OFlag::O_RDWR | OFlag::O_NOCTTY | OFlag::O_NONBLOCK | OFlag::O_CLOEXEC, nix::sys::stat::Mode::empty(), - )?); + )?; + let fd = unsafe { OwnedFd::from_raw_fd(raw_fd) }; // Try to claim exclusive access to the port. This is performed even // if the port will later be set as non-exclusive, in order to respect // other applications that may have an exclusive port lock. - ioctl::tiocexcl(fd.0)?; + ioctl::tiocexcl(fd.as_raw_fd())?; let mut termios = MaybeUninit::uninit(); - nix::errno::Errno::result(unsafe { tcgetattr(fd.0, termios.as_mut_ptr()) })?; + nix::errno::Errno::result(unsafe { tcgetattr(fd.as_raw_fd(), termios.as_mut_ptr()) })?; let mut termios = unsafe { termios.assume_init() }; // setup TTY for binary serial port access @@ -143,11 +124,11 @@ impl TTYPort { unsafe { cfmakeraw(&mut termios) }; // write settings to TTY - unsafe { tcsetattr(fd.0, libc::TCSANOW, &termios) }; + unsafe { tcsetattr(fd.as_raw_fd(), libc::TCSANOW, &termios) }; // Read back settings from port and confirm they were applied correctly let mut actual_termios = MaybeUninit::uninit(); - unsafe { tcgetattr(fd.0, actual_termios.as_mut_ptr()) }; + unsafe { tcgetattr(fd.as_raw_fd(), actual_termios.as_mut_ptr()) }; let actual_termios = unsafe { actual_termios.assume_init() }; if actual_termios.c_iflag != termios.c_iflag @@ -163,14 +144,14 @@ impl TTYPort { #[cfg(any(target_os = "ios", target_os = "macos"))] if builder.baud_rate > 0 { - unsafe { libc::tcflush(fd.0, libc::TCIOFLUSH) }; + unsafe { libc::tcflush(fd.as_raw_fd(), libc::TCIOFLUSH) }; } // clear O_NONBLOCK flag - fcntl(fd.0, F_SETFL(nix::fcntl::OFlag::empty()))?; + fcntl(fd.as_raw_fd(), F_SETFL(nix::fcntl::OFlag::empty()))?; // Configure the low-level port settings - let mut termios = termios::get_termios(fd.0)?; + let mut termios = termios::get_termios(fd.as_raw_fd())?; termios::set_parity(&mut termios, builder.parity); termios::set_flow_control(&mut termios, builder.flow_control); termios::set_data_bits(&mut termios, builder.data_bits); @@ -178,13 +159,13 @@ impl TTYPort { #[cfg(not(any(target_os = "ios", target_os = "macos")))] termios::set_baud_rate(&mut termios, builder.baud_rate)?; #[cfg(any(target_os = "ios", target_os = "macos"))] - termios::set_termios(fd.0, &termios, builder.baud_rate)?; + termios::set_termios(fd.as_raw_fd(), &termios, builder.baud_rate)?; #[cfg(not(any(target_os = "ios", target_os = "macos")))] - termios::set_termios(fd.0, &termios)?; + termios::set_termios(fd.as_raw_fd(), &termios)?; // Return the final port object let mut port = TTYPort { - fd: fd.into_raw(), + fd: fd, timeout: builder.timeout, exclusive: true, port_name: Some(builder.path.clone()), @@ -222,9 +203,9 @@ impl TTYPort { /// * `Io` for any error while setting exclusivity for the port. pub fn set_exclusive(&mut self, exclusive: bool) -> Result<()> { let setting_result = if exclusive { - ioctl::tiocexcl(self.fd) + ioctl::tiocexcl(self.fd.as_raw_fd()) } else { - ioctl::tiocnxcl(self.fd) + ioctl::tiocnxcl(self.fd.as_raw_fd()) }; setting_result?; @@ -234,14 +215,14 @@ impl TTYPort { fn set_pin(&mut self, pin: ioctl::SerialLines, level: bool) -> Result<()> { if level { - ioctl::tiocmbis(self.fd, pin) + ioctl::tiocmbis(self.fd.as_raw_fd(), pin) } else { - ioctl::tiocmbic(self.fd, pin) + ioctl::tiocmbic(self.fd.as_raw_fd(), pin) } } fn read_pin(&mut self, pin: ioctl::SerialLines) -> Result { - ioctl::tiocmget(self.fd).map(|pins| pins.contains(pin)) + ioctl::tiocmget(self.fd.as_raw_fd()).map(|pins| pins.contains(pin)) } /// Create a pair of pseudo serial terminals @@ -317,6 +298,7 @@ impl TTYPort { fd, nix::fcntl::FcntlArg::F_SETFL(nix::fcntl::OFlag::empty()), )?; + let fd = unsafe { OwnedFd::from_raw_fd(fd) }; let slave_tty = TTYPort { fd, @@ -331,7 +313,7 @@ impl TTYPort { // `tcgetattr()` doesn't work on Mac, Solaris, and maybe other // BSDs when used on the master port. let master_tty = TTYPort { - fd: next_pty_fd.into_raw_fd(), + fd: unsafe { OwnedFd::from_raw_fd(next_pty_fd.into_raw_fd()) }, timeout: Duration::from_millis(100), exclusive: true, port_name: None, @@ -345,8 +327,8 @@ impl TTYPort { /// Sends 0-valued bits over the port for a set duration pub fn send_break(&self, duration: BreakDuration) -> Result<()> { match duration { - BreakDuration::Short => nix::sys::termios::tcsendbreak(self.fd, 0), - BreakDuration::Arbitrary(n) => nix::sys::termios::tcsendbreak(self.fd, n.get()), + BreakDuration::Short => nix::sys::termios::tcsendbreak(self.fd.as_fd(), 0), + BreakDuration::Arbitrary(n) => nix::sys::termios::tcsendbreak(self.fd.as_fd(), n.get()), } .map_err(|e| e.into()) } @@ -366,9 +348,12 @@ impl TTYPort { /// /// This function returns an error if the serial port couldn't be cloned. pub fn try_clone_native(&self) -> Result { - let fd_cloned: i32 = fcntl(self.fd, nix::fcntl::F_DUPFD_CLOEXEC(self.fd))?; + let fd_cloned: i32 = fcntl( + self.fd.as_raw_fd(), + nix::fcntl::F_DUPFD_CLOEXEC(self.fd.as_raw_fd()), + )?; Ok(TTYPort { - fd: fd_cloned, + fd: unsafe { OwnedFd::from_raw_fd(fd_cloned) }, exclusive: self.exclusive, port_name: self.port_name.clone(), timeout: self.timeout, @@ -378,15 +363,9 @@ impl TTYPort { } } -impl Drop for TTYPort { - fn drop(&mut self) { - close(self.fd); - } -} - impl AsRawFd for TTYPort { fn as_raw_fd(&self) -> RawFd { - self.fd + self.fd.as_raw_fd() } } @@ -395,7 +374,7 @@ impl IntoRawFd for TTYPort { // Pull just the file descriptor out. We also prevent the destructor // from being run by calling `mem::forget`. If we didn't do this, the // port would be closed, which would make `into_raw_fd` unusable. - let TTYPort { fd, .. } = self; + let fd = self.fd.as_raw_fd(); mem::forget(self); fd } @@ -415,7 +394,7 @@ fn get_termios_speed(fd: RawFd) -> u32 { impl FromRawFd for TTYPort { unsafe fn from_raw_fd(fd: RawFd) -> Self { TTYPort { - fd, + fd: unsafe { OwnedFd::from_raw_fd(fd) }, timeout: Duration::from_millis(100), exclusive: ioctl::tiocexcl(fd).is_ok(), // It is not trivial to get the file path corresponding to a file descriptor. @@ -432,27 +411,27 @@ impl FromRawFd for TTYPort { impl io::Read for TTYPort { fn read(&mut self, buf: &mut [u8]) -> io::Result { - if let Err(e) = super::poll::wait_read_fd(self.fd, self.timeout) { + if let Err(e) = super::poll::wait_read_fd(self.fd.as_fd(), self.timeout) { return Err(io::Error::from(Error::from(e))); } - nix::unistd::read(self.fd, buf).map_err(|e| io::Error::from(Error::from(e))) + nix::unistd::read(self.fd.as_raw_fd(), buf).map_err(|e| io::Error::from(Error::from(e))) } } impl io::Write for TTYPort { fn write(&mut self, buf: &[u8]) -> io::Result { - if let Err(e) = super::poll::wait_write_fd(self.fd, self.timeout) { + if let Err(e) = super::poll::wait_write_fd(self.fd.as_fd(), self.timeout) { return Err(io::Error::from(Error::from(e))); } - nix::unistd::write(self.fd, buf).map_err(|e| io::Error::from(Error::from(e))) + nix::unistd::write(self.fd.as_fd(), buf).map_err(|e| io::Error::from(Error::from(e))) } fn flush(&mut self) -> io::Result<()> { let timeout = Instant::now() + self.timeout; loop { - return match nix::sys::termios::tcdrain(self.fd) { + return match nix::sys::termios::tcdrain(self.fd.as_fd()) { Ok(_) => Ok(()), Err(nix::errno::Errno::EINTR) => { // Retry flushing. But only up to the ports timeout for not retrying @@ -493,7 +472,7 @@ impl SerialPort for TTYPort { ) ))] fn baud_rate(&self) -> Result { - let termios2 = ioctl::tcgets2(self.fd)?; + let termios2 = ioctl::tcgets2(self.fd.as_raw_fd())?; assert!(termios2.c_ospeed == termios2.c_ispeed); @@ -511,7 +490,7 @@ impl SerialPort for TTYPort { target_os = "openbsd" ))] fn baud_rate(&self) -> Result { - let termios = termios::get_termios(self.fd)?; + let termios = termios::get_termios(self.fd.as_raw_fd())?; let ospeed = unsafe { libc::cfgetospeed(&termios) }; let ispeed = unsafe { libc::cfgetispeed(&termios) }; @@ -552,7 +531,7 @@ impl SerialPort for TTYPort { B4800, B50, B57600, B600, B75, B9600, }; - let termios = termios::get_termios(self.fd)?; + let termios = termios::get_termios(self.fd.as_raw_fd())?; let ospeed = unsafe { libc::cfgetospeed(&termios) }; let ispeed = unsafe { libc::cfgetispeed(&termios) }; @@ -596,7 +575,7 @@ impl SerialPort for TTYPort { } fn data_bits(&self) -> Result { - let termios = termios::get_termios(self.fd)?; + let termios = termios::get_termios(self.fd.as_raw_fd())?; match termios.c_cflag & libc::CSIZE { libc::CS8 => Ok(DataBits::Eight), libc::CS7 => Ok(DataBits::Seven), @@ -610,7 +589,7 @@ impl SerialPort for TTYPort { } fn flow_control(&self) -> Result { - let termios = termios::get_termios(self.fd)?; + let termios = termios::get_termios(self.fd.as_raw_fd())?; if termios.c_cflag & libc::CRTSCTS == libc::CRTSCTS { Ok(FlowControl::Hardware) } else if termios.c_iflag & (libc::IXON | libc::IXOFF) == (libc::IXON | libc::IXOFF) { @@ -621,7 +600,7 @@ impl SerialPort for TTYPort { } fn parity(&self) -> Result { - let termios = termios::get_termios(self.fd)?; + let termios = termios::get_termios(self.fd.as_raw_fd())?; if termios.c_cflag & libc::PARENB == libc::PARENB { if termios.c_cflag & libc::PARODD == libc::PARODD { Ok(Parity::Odd) @@ -634,7 +613,7 @@ impl SerialPort for TTYPort { } fn stop_bits(&self) -> Result { - let termios = termios::get_termios(self.fd)?; + let termios = termios::get_termios(self.fd.as_raw_fd())?; if termios.c_cflag & libc::CSTOPB == libc::CSTOPB { Ok(StopBits::Two) } else { @@ -655,53 +634,53 @@ impl SerialPort for TTYPort { target_os = "linux" ))] fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()> { - let mut termios = termios::get_termios(self.fd)?; + let mut termios = termios::get_termios(self.fd.as_raw_fd())?; termios::set_baud_rate(&mut termios, baud_rate)?; - termios::set_termios(self.fd, &termios) + termios::set_termios(self.fd.as_raw_fd(), &termios) } // Mac OS needs special logic for setting arbitrary baud rates. #[cfg(any(target_os = "ios", target_os = "macos"))] fn set_baud_rate(&mut self, baud_rate: u32) -> Result<()> { - ioctl::iossiospeed(self.fd, &(baud_rate as libc::speed_t))?; + ioctl::iossiospeed(self.fd.as_raw_fd(), &(baud_rate as libc::speed_t))?; self.baud_rate = baud_rate; Ok(()) } fn set_flow_control(&mut self, flow_control: FlowControl) -> Result<()> { - let mut termios = termios::get_termios(self.fd)?; + let mut termios = termios::get_termios(self.fd.as_raw_fd())?; termios::set_flow_control(&mut termios, flow_control); #[cfg(any(target_os = "ios", target_os = "macos"))] - return termios::set_termios(self.fd, &termios, self.baud_rate); + return termios::set_termios(self.fd.as_raw_fd(), &termios, self.baud_rate); #[cfg(not(any(target_os = "ios", target_os = "macos")))] - return termios::set_termios(self.fd, &termios); + return termios::set_termios(self.fd.as_raw_fd(), &termios); } fn set_parity(&mut self, parity: Parity) -> Result<()> { - let mut termios = termios::get_termios(self.fd)?; + let mut termios = termios::get_termios(self.fd.as_raw_fd())?; termios::set_parity(&mut termios, parity); #[cfg(any(target_os = "ios", target_os = "macos"))] - return termios::set_termios(self.fd, &termios, self.baud_rate); + return termios::set_termios(self.fd.as_raw_fd(), &termios, self.baud_rate); #[cfg(not(any(target_os = "ios", target_os = "macos")))] - return termios::set_termios(self.fd, &termios); + return termios::set_termios(self.fd.as_raw_fd(), &termios); } fn set_data_bits(&mut self, data_bits: DataBits) -> Result<()> { - let mut termios = termios::get_termios(self.fd)?; + let mut termios = termios::get_termios(self.fd.as_raw_fd())?; termios::set_data_bits(&mut termios, data_bits); #[cfg(any(target_os = "ios", target_os = "macos"))] - return termios::set_termios(self.fd, &termios, self.baud_rate); + return termios::set_termios(self.fd.as_raw_fd(), &termios, self.baud_rate); #[cfg(not(any(target_os = "ios", target_os = "macos")))] - return termios::set_termios(self.fd, &termios); + return termios::set_termios(self.fd.as_raw_fd(), &termios); } fn set_stop_bits(&mut self, stop_bits: StopBits) -> Result<()> { - let mut termios = termios::get_termios(self.fd)?; + let mut termios = termios::get_termios(self.fd.as_raw_fd())?; termios::set_stop_bits(&mut termios, stop_bits); #[cfg(any(target_os = "ios", target_os = "macos"))] - return termios::set_termios(self.fd, &termios, self.baud_rate); + return termios::set_termios(self.fd.as_raw_fd(), &termios, self.baud_rate); #[cfg(not(any(target_os = "ios", target_os = "macos")))] - return termios::set_termios(self.fd, &termios); + return termios::set_termios(self.fd.as_raw_fd(), &termios); } fn set_timeout(&mut self, timeout: Duration) -> Result<()> { @@ -734,11 +713,11 @@ impl SerialPort for TTYPort { } fn bytes_to_read(&self) -> Result { - ioctl::fionread(self.fd) + ioctl::fionread(self.fd.as_raw_fd()) } fn bytes_to_write(&self) -> Result { - ioctl::tiocoutq(self.fd) + ioctl::tiocoutq(self.fd.as_raw_fd()) } fn clear(&self, buffer_to_clear: ClearBuffer) -> Result<()> { @@ -748,7 +727,7 @@ impl SerialPort for TTYPort { ClearBuffer::All => libc::TCIOFLUSH, }; - let res = unsafe { nix::libc::tcflush(self.fd, buffer_id) }; + let res = unsafe { nix::libc::tcflush(self.fd.as_raw_fd(), buffer_id) }; nix::errno::Errno::result(res) .map(|_| ()) @@ -763,11 +742,11 @@ impl SerialPort for TTYPort { } fn set_break(&self) -> Result<()> { - ioctl::tiocsbrk(self.fd) + ioctl::tiocsbrk(self.fd.as_raw_fd()) } fn clear_break(&self) -> Result<()> { - ioctl::tioccbrk(self.fd) + ioctl::tioccbrk(self.fd.as_raw_fd()) } }