| //! The Unix `ioctl` function is effectively lots of different functions |
| //! hidden behind a single dynamic dispatch interface. In order to provide |
| //! a type-safe API, rustix makes them all separate functions so that they |
| //! can have dedicated static type signatures. |
| |
| use crate::{backend, io}; |
| use backend::fd::AsFd; |
| |
| /// `ioctl(fd, TIOCEXCL)`—Enables exclusive mode on a terminal. |
| /// |
| /// # References |
| /// - [Linux] |
| /// |
| /// [Linux]: https://man7.org/linux/man-pages/man4/tty_ioctl.4.html |
| #[cfg(not(any(windows, target_os = "haiku", target_os = "redox", target_os = "wasi")))] |
| #[inline] |
| #[doc(alias = "TIOCEXCL")] |
| pub fn ioctl_tiocexcl<Fd: AsFd>(fd: Fd) -> io::Result<()> { |
| backend::io::syscalls::ioctl_tiocexcl(fd.as_fd()) |
| } |
| |
| /// `ioctl(fd, TIOCNXCL)`—Disables exclusive mode on a terminal. |
| /// |
| /// # References |
| /// - [Linux] |
| /// |
| /// [Linux]: https://man7.org/linux/man-pages/man4/tty_ioctl.4.html |
| #[cfg(not(any(windows, target_os = "haiku", target_os = "redox", target_os = "wasi")))] |
| #[inline] |
| #[doc(alias = "TIOCNXCL")] |
| pub fn ioctl_tiocnxcl<Fd: AsFd>(fd: Fd) -> io::Result<()> { |
| backend::io::syscalls::ioctl_tiocnxcl(fd.as_fd()) |
| } |
| |
| /// `ioctl(fd, FIOCLEX)`—Set the close-on-exec flag. |
| /// |
| /// Also known as `fcntl(fd, F_SETFD, FD_CLOEXEC)`. |
| /// |
| /// # References |
| /// - [Linux] |
| /// - [Winsock2] |
| /// |
| /// [Linux]: https://man7.org/linux/man-pages/man2/ioctl.2.html |
| /// [Winsock2]: https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-ioctlsocket |
| #[cfg(apple)] |
| #[inline] |
| #[doc(alias = "FIOCLEX")] |
| #[doc(alias = "FD_CLOEXEC")] |
| pub fn ioctl_fioclex<Fd: AsFd>(fd: Fd) -> io::Result<()> { |
| backend::io::syscalls::ioctl_fioclex(fd.as_fd()) |
| } |
| |
| /// `ioctl(fd, FIONBIO, &value)`—Enables or disables non-blocking mode. |
| /// |
| /// # References |
| /// - [Linux] |
| /// - [Winsock2] |
| /// |
| /// [Linux]: https://man7.org/linux/man-pages/man2/ioctl.2.html |
| /// [Winsock2]: https://docs.microsoft.com/en-us/windows/win32/winsock/winsock-ioctls#unix-ioctl-codes |
| #[inline] |
| #[doc(alias = "FIONBIO")] |
| pub fn ioctl_fionbio<Fd: AsFd>(fd: Fd, value: bool) -> io::Result<()> { |
| backend::io::syscalls::ioctl_fionbio(fd.as_fd(), value) |
| } |
| |
| /// `ioctl(fd, FIONREAD)`—Returns the number of bytes ready to be read. |
| /// |
| /// The result of this function gets silently coerced into a C `int` |
| /// by the OS, so it may contain a wrapped value. |
| /// |
| /// # References |
| /// - [Linux] |
| /// - [Winsock2] |
| /// |
| /// [Linux]: https://man7.org/linux/man-pages/man2/ioctl_tty.2.html |
| /// [Winsock2]: https://docs.microsoft.com/en-us/windows/win32/winsock/winsock-ioctls#unix-ioctl-codes |
| #[cfg(not(target_os = "redox"))] |
| #[inline] |
| #[doc(alias = "FIONREAD")] |
| pub fn ioctl_fionread<Fd: AsFd>(fd: Fd) -> io::Result<u64> { |
| backend::io::syscalls::ioctl_fionread(fd.as_fd()) |
| } |
| |
| /// `ioctl(fd, BLKSSZGET)`—Returns the logical block size of a block device. |
| #[cfg(any(target_os = "android", target_os = "linux"))] |
| #[inline] |
| #[doc(alias = "BLKSSZGET")] |
| pub fn ioctl_blksszget<Fd: AsFd>(fd: Fd) -> io::Result<u32> { |
| backend::io::syscalls::ioctl_blksszget(fd.as_fd()) |
| } |
| |
| /// `ioctl(fd, BLKPBSZGET)`—Returns the physical block size of a block device. |
| #[cfg(any(target_os = "android", target_os = "linux"))] |
| #[inline] |
| #[doc(alias = "BLKPBSZGET")] |
| pub fn ioctl_blkpbszget<Fd: AsFd>(fd: Fd) -> io::Result<u32> { |
| backend::io::syscalls::ioctl_blkpbszget(fd.as_fd()) |
| } |
| |
| /// `ioctl(fd, FICLONE, src_fd)`—Share data between open files. |
| /// |
| /// # References |
| /// - [Linux] |
| /// |
| /// [Linux]: https://man7.org/linux/man-pages/man2/ioctl_ficlone.2.html |
| #[cfg(any(target_os = "android", target_os = "linux"))] |
| #[inline] |
| #[doc(alias = "FICLONE")] |
| pub fn ioctl_ficlone<Fd: AsFd, SrcFd: AsFd>(fd: Fd, src_fd: SrcFd) -> io::Result<()> { |
| backend::io::syscalls::ioctl_ficlone(fd.as_fd(), src_fd.as_fd()) |
| } |