Crate ioctl_id

Expand description

Provides constant functions to compute for ioctl(2) identifiers.

Currently, this supports Linux and macOS. The long term goal is to support ioctl identifiers for other BSD variants.

IoctlId is an alias for the type to pass into the ioctl(2) request. This is either a u32 or u64, depending on the target OS and architecture.

The io(), ior(), iow(), and iowr() functions take a type parameter, similar to the _IO(), _IOR(), _IOW(), and _IOWR() macros.

For example, the following C code:

struct my_ioctl_data {
    unsigned int a;
};

#define MY_IOCTL _IOR(0x12, 0x34, struct my_ioctl_data)

Would be written in Rust as:

use ioctl_id::*;

#[repr(C)]
struct MyIoctlData {
   a: u32,
}

const MY_IOCTL: IoctlId = ior::<MyIoctlData>(0x12, 0x34);

Constants§

IOC_DIRBITS: The number of bits used to represent the direction of the ioctl(2) call.
IOC_DIRMASK: Bitmask for valid ioctl(2) direction values.
IOC_DIRSHIFT: The number of bits to shift ioctl(2) direction values by.
IOC_NONE: Direction bit specifying no data is read or written.
IOC_NRBITS: This is the same for all architectures.
IOC_NRMASK: Bitmask for valid ioctl(2) call identifiers.
IOC_NRSHIFT: The number of bits to shift ioctl(2) call identifiers by.
IOC_READ: Direction bit specifying data is read.
IOC_SIZEBITS: The number of bits used to represent the size of the argument to the ioctl(2) call.
IOC_SIZEMASK: Bitmask for valid ioctl(2) size values.
IOC_SIZESHIFT: The number of bits to shift ioctl(2) size values by.
IOC_TYPEBITS: The number of bits available for ioctl(2) type identifiers.
IOC_TYPEMASK: Bitmask for valid ioctl(2) type identifiers.
IOC_TYPESHIFT: The number of bits to shift ioctl(2) type identifiers by.
IOC_WRITE: Direction bit specifying data is written.

io: Create an ioctl(2) identifier for a call that passes no data.
ioc: Create an ioctl(2) identifier from a direction value, type identifier, call identifier, and size value.
ioc_dir: Decode the direction value from an ioctl(2) identifier.
ioc_nr: Decode the call identifier from an ioctl(2) identifier.
ioc_size: Decode the size identifier from an ioctl(2) identifier.
ioc_type: Decode the type identifier from an ioctl(2) identifier.
ior: Create an ioctl(2) identifier for a call that reads data.
iow: Create an ioctl(2) identifier for a call that writes data.
iowr: Create an ioctl(2) identifier for a call that reads and writes data.