      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140

    /// The datatype used for the ioctl number
    #[cfg(any(target_os = "android", target_env = "musl"))]
    #[doc(hidden)]
    pub type ioctl_num_type = ::libc::c_int;
    #[cfg(not(any(target_os = "android", target_env = "musl")))]
    #[doc(hidden)]
    pub type ioctl_num_type = ::libc::c_ulong;
    /// The datatype used for the 3rd argument
    #[doc(hidden)]
    pub type ioctl_param_type = ::libc::c_ulong;

    #[doc(hidden)]
    pub const NRBITS: ioctl_num_type = 8;
    #[doc(hidden)]
    pub const TYPEBITS: ioctl_num_type = 8;

    #[cfg(any(target_arch = "mips", target_arch = "mips64", target_arch = "powerpc", target_arch = "powerpc64", target_arch = "sparc64"))]
    mod consts {
        #[doc(hidden)]
        pub const NONE: u8 = 1;
        #[doc(hidden)]
        pub const READ: u8 = 2;
        #[doc(hidden)]
        pub const WRITE: u8 = 4;
        #[doc(hidden)]
        pub const SIZEBITS: u8 = 13;
        #[doc(hidden)]
        pub const DIRBITS: u8 = 3;
    }

    // "Generic" ioctl protocol
    #[cfg(any(target_arch = "x86",
              target_arch = "arm",
              target_arch = "s390x",
              target_arch = "x86_64",
              target_arch = "aarch64"))]
    mod consts {
        #[doc(hidden)]
        pub const NONE: u8 = 0;
        #[doc(hidden)]
        pub const READ: u8 = 2;
        #[doc(hidden)]
        pub const WRITE: u8 = 1;
        #[doc(hidden)]
        pub const SIZEBITS: u8 = 14;
        #[doc(hidden)]
        pub const DIRBITS: u8 = 2;
    }

    pub use self::consts::*;

    #[doc(hidden)]
    pub const NRSHIFT: ioctl_num_type = 0;
    #[doc(hidden)]
    pub const TYPESHIFT: ioctl_num_type = NRSHIFT + NRBITS as ioctl_num_type;
    #[doc(hidden)]
    pub const SIZESHIFT: ioctl_num_type = TYPESHIFT + TYPEBITS as ioctl_num_type;
    #[doc(hidden)]
    pub const DIRSHIFT: ioctl_num_type = SIZESHIFT + SIZEBITS as ioctl_num_type;

    #[doc(hidden)]
    pub const NRMASK: ioctl_num_type = (1 << NRBITS) - 1;
    #[doc(hidden)]
    pub const TYPEMASK: ioctl_num_type = (1 << TYPEBITS) - 1;
    #[doc(hidden)]
    pub const SIZEMASK: ioctl_num_type = (1 << SIZEBITS) - 1;
    #[doc(hidden)]
    pub const DIRMASK: ioctl_num_type = (1 << DIRBITS) - 1;

    /// Encode an ioctl command.
    #[macro_export]
    #[doc(hidden)]
    macro_rules! ioc {
        ($dir:expr, $ty:expr, $nr:expr, $sz:expr) => (
            (($dir as $crate::sys::ioctl::ioctl_num_type & $crate::sys::ioctl::DIRMASK) << $crate::sys::ioctl::DIRSHIFT) |
            (($ty as $crate::sys::ioctl::ioctl_num_type & $crate::sys::ioctl::TYPEMASK) << $crate::sys::ioctl::TYPESHIFT) |
            (($nr as $crate::sys::ioctl::ioctl_num_type & $crate::sys::ioctl::NRMASK) << $crate::sys::ioctl::NRSHIFT) |
            (($sz as $crate::sys::ioctl::ioctl_num_type & $crate::sys::ioctl::SIZEMASK) << $crate::sys::ioctl::SIZESHIFT))
    }

    /// Generate an ioctl request code for a command that passes no data.
    ///
    /// This is equivalent to the `_IO()` macro exposed by the C ioctl API.
    ///
    /// You should only use this macro directly if the `ioctl` you're working
    /// with is "bad" and you cannot use `ioctl_none!()` directly.
    ///
    /// # Example
    ///
    /// ```
    /// # #[macro_use] extern crate nix;
    /// const KVMIO: u8 = 0xAE;
    /// ioctl_write_int_bad!(kvm_create_vm, request_code_none!(KVMIO, 0x03));
    /// # fn main() {}
    /// ```
    #[macro_export(local_inner_macros)]
    macro_rules! request_code_none {
        ($ty:expr, $nr:expr) => (ioc!($crate::sys::ioctl::NONE, $ty, $nr, 0))
    }

    /// Generate an ioctl request code for a command that reads.
    ///
    /// This is equivalent to the `_IOR()` macro exposed by the C ioctl API.
    ///
    /// You should only use this macro directly if the `ioctl` you're working
    /// with is "bad" and you cannot use `ioctl_read!()` directly.
    ///
    /// The read/write direction is relative to userland, so this
    /// command would be userland is reading and the kernel is
    /// writing.
    #[macro_export(local_inner_macros)]
    macro_rules! request_code_read {
        ($ty:expr, $nr:expr, $sz:expr) => (ioc!($crate::sys::ioctl::READ, $ty, $nr, $sz))
    }

    /// Generate an ioctl request code for a command that writes.
    ///
    /// This is equivalent to the `_IOW()` macro exposed by the C ioctl API.
    ///
    /// You should only use this macro directly if the `ioctl` you're working
    /// with is "bad" and you cannot use `ioctl_write!()` directly.
    ///
    /// The read/write direction is relative to userland, so this
    /// command would be userland is writing and the kernel is
    /// reading.
    #[macro_export(local_inner_macros)]
    macro_rules! request_code_write {
        ($ty:expr, $nr:expr, $sz:expr) => (ioc!($crate::sys::ioctl::WRITE, $ty, $nr, $sz))
    }

    /// Generate an ioctl request code for a command that reads and writes.
    ///
    /// This is equivalent to the `_IOWR()` macro exposed by the C ioctl API.
    ///
    /// You should only use this macro directly if the `ioctl` you're working
    /// with is "bad" and you cannot use `ioctl_readwrite!()` directly.
    #[macro_export(local_inner_macros)]
    macro_rules! request_code_readwrite {
        ($ty:expr, $nr:expr, $sz:expr) => (ioc!($crate::sys::ioctl::READ | $crate::sys::ioctl::WRITE, $ty, $nr, $sz))
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)