Accept AsFd in ioctl macros

changelog/2727.changed.md

@@ -0,0 +1 @@
+Accept `AsFd` in `ioctl` macros

src/sys/ioctl/mod.rs

@@ -261,7 +261,7 @@ macro_rules! convert_ioctl_res {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -285,8 +285,9 @@ macro_rules! convert_ioctl_res {
 macro_rules! ioctl_none {
     ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int)
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, request_code_none!($ioty, $nr) as $crate::sys::ioctl::ioctl_num_type))
             }
@@ -304,7 +305,7 @@ macro_rules! ioctl_none {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -315,20 +316,20 @@ macro_rules! ioctl_none {
 /// # #[macro_use] extern crate nix;
 /// # use libc::TIOCNXCL;
 /// # use std::fs::File;
-/// # use std::os::unix::io::AsRawFd;
 /// ioctl_none_bad!(tiocnxcl, TIOCNXCL);
 /// fn main() {
 ///     let file = File::open("/dev/ttyUSB0").unwrap();
-///     unsafe { tiocnxcl(file.as_raw_fd()) }.unwrap();
+///     unsafe { tiocnxcl(&file) }.unwrap();
 /// }
 /// ```
 // TODO: add an example using request_code_*!()
 #[macro_export(local_inner_macros)]
 macro_rules! ioctl_none_bad {
     ($(#[$attr:meta])* $name:ident, $nr:expr) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int)
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, $nr as $crate::sys::ioctl::ioctl_num_type))
             }
@@ -348,7 +349,7 @@ macro_rules! ioctl_none_bad {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: *mut DATA_TYPE) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -366,9 +367,10 @@ macro_rules! ioctl_none_bad {
 macro_rules! ioctl_read {
     ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: *mut $ty)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, request_code_read!($ioty, $nr, ::std::mem::size_of::<$ty>()) as $crate::sys::ioctl::ioctl_num_type, data))
             }
@@ -387,7 +389,7 @@ macro_rules! ioctl_read {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: *mut DATA_TYPE) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -404,9 +406,10 @@ macro_rules! ioctl_read {
 macro_rules! ioctl_read_bad {
     ($(#[$attr:meta])* $name:ident, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: *mut $ty)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, $nr as $crate::sys::ioctl::ioctl_num_type, data))
             }
@@ -426,7 +429,7 @@ macro_rules! ioctl_read_bad {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *const DATA_TYPE) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: *const DATA_TYPE) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -443,9 +446,10 @@ macro_rules! ioctl_read_bad {
 macro_rules! ioctl_write_ptr {
     ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: *const $ty)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, request_code_write!($ioty, $nr, ::std::mem::size_of::<$ty>()) as $crate::sys::ioctl::ioctl_num_type, data))
             }
@@ -464,7 +468,7 @@ macro_rules! ioctl_write_ptr {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *const DATA_TYPE) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: *const DATA_TYPE) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -481,9 +485,10 @@ macro_rules! ioctl_write_ptr {
 macro_rules! ioctl_write_ptr_bad {
     ($(#[$attr:meta])* $name:ident, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: *const $ty)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, $nr as $crate::sys::ioctl::ioctl_num_type, data))
             }
@@ -504,7 +509,7 @@ cfg_if! {
         /// The generated function has the following signature:
         ///
         /// ```rust,ignore
-        /// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: nix::sys::ioctl::ioctl_param_type) -> Result<libc::c_int>
+        /// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: nix::sys::ioctl::ioctl_param_type) -> Result<libc::c_int>
         /// ```
         ///
         /// `nix::sys::ioctl::ioctl_param_type` depends on the OS:
@@ -524,9 +529,10 @@ cfg_if! {
         macro_rules! ioctl_write_int {
             ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr) => (
                 $(#[$attr])*
-                pub unsafe fn $name(fd: $crate::libc::c_int,
+                pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                                     data: $crate::sys::ioctl::ioctl_param_type)
                                     -> $crate::Result<$crate::libc::c_int> {
+                    let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
                     unsafe {
                         convert_ioctl_res!($crate::libc::ioctl(fd, request_code_write_int!($ioty, $nr) as $crate::sys::ioctl::ioctl_num_type, data))
                     }
@@ -545,7 +551,7 @@ cfg_if! {
         /// The generated function has the following signature:
         ///
         /// ```rust,ignore
-        /// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: nix::sys::ioctl::ioctl_param_type) -> Result<libc::c_int>
+        /// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: nix::sys::ioctl::ioctl_param_type) -> Result<libc::c_int>
         /// ```
         ///
         /// `nix::sys::ioctl::ioctl_param_type` depends on the OS:
@@ -567,9 +573,10 @@ cfg_if! {
         macro_rules! ioctl_write_int {
             ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr) => (
                 $(#[$attr])*
-                pub unsafe fn $name(fd: $crate::libc::c_int,
+                pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                                     data: $crate::sys::ioctl::ioctl_param_type)
                                     -> $crate::Result<$crate::libc::c_int> {
+                    let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
                     unsafe {
                         convert_ioctl_res!($crate::libc::ioctl(fd, request_code_write!($ioty, $nr, ::std::mem::size_of::<$crate::libc::c_int>()) as $crate::sys::ioctl::ioctl_num_type, data))
                     }
@@ -589,7 +596,7 @@ cfg_if! {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: libc::c_int) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: libc::c_int) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -613,9 +620,10 @@ cfg_if! {
 macro_rules! ioctl_write_int_bad {
     ($(#[$attr:meta])* $name:ident, $nr:expr) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: $crate::libc::c_int)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, $nr as $crate::sys::ioctl::ioctl_num_type, data))
             }
@@ -635,7 +643,7 @@ macro_rules! ioctl_write_int_bad {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: *mut DATA_TYPE) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -652,9 +660,10 @@ macro_rules! ioctl_write_int_bad {
 macro_rules! ioctl_readwrite {
     ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: *mut $ty)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             let ioty = $ioty;
             let nr = $nr;
             unsafe {
@@ -675,7 +684,7 @@ macro_rules! ioctl_readwrite {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: *mut DATA_TYPE) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: *mut DATA_TYPE) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -684,9 +693,10 @@ macro_rules! ioctl_readwrite {
 macro_rules! ioctl_readwrite_bad {
     ($(#[$attr:meta])* $name:ident, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: *mut $ty)
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, $nr as $crate::sys::ioctl::ioctl_num_type, data))
             }
@@ -706,7 +716,7 @@ macro_rules! ioctl_readwrite_bad {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: &mut [DATA_TYPE]) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: &mut [DATA_TYPE]) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -715,9 +725,10 @@ macro_rules! ioctl_readwrite_bad {
 macro_rules! ioctl_read_buf {
     ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: &mut [$ty])
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, request_code_read!($ioty, $nr, ::std::mem::size_of_val(data)) as $crate::sys::ioctl::ioctl_num_type, data.as_mut_ptr()))
             }
@@ -737,7 +748,7 @@ macro_rules! ioctl_read_buf {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: &[DATA_TYPE]) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: &[DATA_TYPE]) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -756,9 +767,10 @@ macro_rules! ioctl_read_buf {
 macro_rules! ioctl_write_buf {
     ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: &[$ty])
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, request_code_write!($ioty, $nr, ::std::mem::size_of_val(data)) as $crate::sys::ioctl::ioctl_num_type, data.as_ptr()))
             }
@@ -778,7 +790,7 @@ macro_rules! ioctl_write_buf {
 /// The generated function has the following signature:
 ///
 /// ```rust,ignore
-/// pub unsafe fn FUNCTION_NAME(fd: libc::c_int, data: &mut [DATA_TYPE]) -> Result<libc::c_int>
+/// pub unsafe fn FUNCTION_NAME<Fd: AsFd>(fd: Fd, data: &mut [DATA_TYPE]) -> Result<libc::c_int>
 /// ```
 ///
 /// For a more in-depth explanation of ioctls, see [`::sys::ioctl`](sys/ioctl/index.html).
@@ -787,9 +799,10 @@ macro_rules! ioctl_write_buf {
 macro_rules! ioctl_readwrite_buf {
     ($(#[$attr:meta])* $name:ident, $ioty:expr, $nr:expr, $ty:ty) => (
         $(#[$attr])*
-        pub unsafe fn $name(fd: $crate::libc::c_int,
+        pub unsafe fn $name<Fd: ::std::os::fd::AsFd>(fd: Fd,
                             data: &mut [$ty])
                             -> $crate::Result<$crate::libc::c_int> {
+            let fd = ::std::os::fd::AsRawFd::as_raw_fd(&fd.as_fd());
             unsafe {
                 convert_ioctl_res!($crate::libc::ioctl(fd, request_code_readwrite!($ioty, $nr, ::std::mem::size_of_val(data)) as $crate::sys::ioctl::ioctl_num_type, data.as_mut_ptr()))
             }

src/sys/socket/addr.rs

@@ -1732,7 +1732,7 @@ pub mod sys_control {
     use crate::sys::socket::addr::AddressFamily;
     use libc::{self, c_uchar};
     use std::{fmt, mem, ptr};
-    use std::os::unix::io::RawFd;
+
     use crate::{Errno, Result};
     use super::{private, SockaddrLike};
 
@@ -1801,7 +1801,7 @@ pub mod sys_control {
 
         /// Construct a new `SysControlAddr` from its human readable name and
         /// unit number.
-        pub fn from_name(sockfd: RawFd, name: &str, unit: u32) -> Result<SysControlAddr> {
+        pub fn from_name<Fd: ::std::os::fd::AsFd>(sockfd: Fd, name: &str, unit: u32) -> Result<SysControlAddr> {
             if name.len() > MAX_KCTL_NAME {
                 return Err(Errno::ENAMETOOLONG);
             }