summaryrefslogtreecommitdiff
path: root/test/sys/test_ioctl.rs
blob: 236d24268a738493ca5229e3109e9cb82a4129a6 (plain)
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
#![allow(dead_code)]

// Simple tests to ensure macro generated fns compile
ioctl_none_bad!(do_bad, 0x1234);
ioctl_read_bad!(do_bad_read, 0x1234, u16);
ioctl_write_int_bad!(do_bad_write_int, 0x1234);
ioctl_write_ptr_bad!(do_bad_write_ptr, 0x1234, u8);
ioctl_readwrite_bad!(do_bad_readwrite, 0x1234, u32);
ioctl_none!(do_none, 0, 0);
ioctl_read!(read_test, 0, 0, u32);
ioctl_write_int!(write_ptr_int, 0, 0);
ioctl_write_ptr!(write_ptr_u8, 0, 0, u8);
ioctl_write_ptr!(write_ptr_u32, 0, 0, u32);
ioctl_write_ptr!(write_ptr_u64, 0, 0, u64);
ioctl_readwrite!(readwrite_test, 0, 0, u64);
ioctl_read_buf!(readbuf_test, 0, 0, u32);
const SPI_IOC_MAGIC: u8 = b'k';
const SPI_IOC_MESSAGE: u8 = 0;
ioctl_write_buf!(writebuf_test_consts, SPI_IOC_MAGIC, SPI_IOC_MESSAGE, u8);
ioctl_write_buf!(writebuf_test_u8, 0, 0, u8);
ioctl_write_buf!(writebuf_test_u32, 0, 0, u32);
ioctl_write_buf!(writebuf_test_u64, 0, 0, u64);
ioctl_readwrite_buf!(readwritebuf_test, 0, 0, u32);

// See C code for source of values for op calculations (does NOT work for mips/powerpc):
// https://gist.github.com/posborne/83ea6880770a1aef332e
//
// TODO:  Need a way to compute these constants at test time.  Using precomputed
// values is fragile and needs to be maintained.

#[cfg(any(target_os = "linux", target_os = "android"))]
mod linux {
    #[test]
    fn test_op_none() {
        if cfg!(any(target_arch = "mips", target_arch = "mips64", target_arch="powerpc", target_arch="powerpc64")){
            assert_eq!(request_code_none!(b'q', 10) as u32, 0x2000_710A);
            assert_eq!(request_code_none!(b'a', 255) as u32, 0x2000_61FF);
        } else {
            assert_eq!(request_code_none!(b'q', 10) as u32, 0x0000_710A);
            assert_eq!(request_code_none!(b'a', 255) as u32, 0x0000_61FF);
        }
    }

    #[test]
    fn test_op_write() {
        if cfg!(any(target_arch = "mips", target_arch = "mips64", target_arch="powerpc", target_arch="powerpc64")){
            assert_eq!(request_code_write!(b'z', 10, 1) as u32, 0x8001_7A0A);
            assert_eq!(request_code_write!(b'z', 10, 512) as u32, 0x8200_7A0A);
        } else {
            assert_eq!(request_code_write!(b'z', 10, 1) as u32, 0x4001_7A0A);
            assert_eq!(request_code_write!(b'z', 10, 512) as u32, 0x4200_7A0A);
        }
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn test_op_write_64() {
        if cfg!(any(target_arch = "mips64", target_arch="powerpc64")){
            assert_eq!(request_code_write!(b'z', 10, 1u64 << 32) as u32,
                       0x8000_7A0A);
        } else {
            assert_eq!(request_code_write!(b'z', 10, 1u64 << 32) as u32,
                       0x4000_7A0A);
        }

    }

    #[test]
    fn test_op_read() {
        if cfg!(any(target_arch = "mips", target_arch = "mips64", target_arch="powerpc", target_arch="powerpc64")){
            assert_eq!(request_code_read!(b'z', 10, 1) as u32, 0x4001_7A0A);
            assert_eq!(request_code_read!(b'z', 10, 512) as u32, 0x4200_7A0A);
        } else {
            assert_eq!(request_code_read!(b'z', 10, 1) as u32, 0x8001_7A0A);
            assert_eq!(request_code_read!(b'z', 10, 512) as u32, 0x8200_7A0A);
        }
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn test_op_read_64() {
        if cfg!(any(target_arch = "mips64", target_arch="powerpc64")){
            assert_eq!(request_code_read!(b'z', 10, 1u64 << 32) as u32,
                       0x4000_7A0A);
        } else {
            assert_eq!(request_code_read!(b'z', 10, 1u64 << 32) as u32,
                       0x8000_7A0A);
        }
    }

    #[test]
    fn test_op_read_write() {
        assert_eq!(request_code_readwrite!(b'z', 10, 1) as u32, 0xC001_7A0A);
        assert_eq!(request_code_readwrite!(b'z', 10, 512) as u32, 0xC200_7A0A);
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn test_op_read_write_64() {
        assert_eq!(request_code_readwrite!(b'z', 10, 1u64 << 32) as u32,
                   0xC000_7A0A);
    }
}

#[cfg(any(target_os = "dragonfly",
          target_os = "freebsd",
          target_os = "ios",
          target_os = "macos",
          target_os = "netbsd",
          target_os = "openbsd"))]
mod bsd {
    #[test]
    fn test_op_none() {
        assert_eq!(request_code_none!(b'q', 10), 0x2000_710A);
        assert_eq!(request_code_none!(b'a', 255), 0x2000_61FF);
    }

    #[cfg(any(target_os = "dragonfly", target_os = "freebsd"))]
    #[test]
    fn test_op_write_int() {
        assert_eq!(request_code_write_int!(b'v', 4), 0x2004_7604);
        assert_eq!(request_code_write_int!(b'p', 2), 0x2004_7002);
    }

    #[test]
    fn test_op_write() {
        assert_eq!(request_code_write!(b'z', 10, 1), 0x8001_7A0A);
        assert_eq!(request_code_write!(b'z', 10, 512), 0x8200_7A0A);
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn test_op_write_64() {
        assert_eq!(request_code_write!(b'z', 10, 1u64 << 32), 0x8000_7A0A);
    }

    #[test]
    fn test_op_read() {
        assert_eq!(request_code_read!(b'z', 10, 1), 0x4001_7A0A);
        assert_eq!(request_code_read!(b'z', 10, 512), 0x4200_7A0A);
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn test_op_read_64() {
        assert_eq!(request_code_read!(b'z', 10, 1u64 << 32), 0x4000_7A0A);
    }

    #[test]
    fn test_op_read_write() {
        assert_eq!(request_code_readwrite!(b'z', 10, 1), 0xC001_7A0A);
        assert_eq!(request_code_readwrite!(b'z', 10, 512), 0xC200_7A0A);
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn test_op_read_write_64() {
        assert_eq!(request_code_readwrite!(b'z', 10, 1u64 << 32), 0xC000_7A0A);
    }
}

#[cfg(any(target_os = "android", target_os = "linux"))]
mod linux_ioctls {
    use std::mem;
    use std::os::unix::io::AsRawFd;

    use tempfile::tempfile;
    use libc::{TCGETS, TCSBRK, TCSETS, TIOCNXCL, termios};

    use nix::errno::Errno;

    ioctl_none_bad!(tiocnxcl, TIOCNXCL);
    #[test]
    fn test_ioctl_none_bad() {
        let file = tempfile().unwrap();
        let res = unsafe { tiocnxcl(file.as_raw_fd()) };
        assert_eq!(res, Err(Errno::ENOTTY));
    }

    ioctl_read_bad!(tcgets, TCGETS, termios);
    #[test]
    fn test_ioctl_read_bad() {
        let file = tempfile().unwrap();
        let mut termios = unsafe { mem::zeroed() };
        let res = unsafe { tcgets(file.as_raw_fd(), &mut termios) };
        assert_eq!(res, Err(Errno::ENOTTY));
    }

    ioctl_write_int_bad!(tcsbrk, TCSBRK);
    #[test]
    fn test_ioctl_write_int_bad() {
        let file = tempfile().unwrap();
        let res = unsafe { tcsbrk(file.as_raw_fd(), 0) };
        assert_eq!(res, Err(Errno::ENOTTY));
    }

    ioctl_write_ptr_bad!(tcsets, TCSETS, termios);
    #[test]
    fn test_ioctl_write_ptr_bad() {
        let file = tempfile().unwrap();
        let termios: termios = unsafe { mem::zeroed() };
        let res = unsafe { tcsets(file.as_raw_fd(), &termios) };
        assert_eq!(res, Err(Errno::ENOTTY));
    }

    // FIXME: Find a suitable example for `ioctl_readwrite_bad`

    // From linux/videodev2.h
    ioctl_none!(log_status, b'V', 70);
    #[test]
    fn test_ioctl_none() {
        let file = tempfile().unwrap();
        let res = unsafe { log_status(file.as_raw_fd()) };
        assert!(res == Err(Errno::ENOTTY) || res == Err(Errno::ENOSYS));
    }

    #[repr(C)]
    pub struct v4l2_audio {
        index: u32,
        name: [u8; 32],
        capability: u32,
        mode: u32,
        reserved: [u32; 2],
    }

    // From linux/videodev2.h
    ioctl_write_ptr!(s_audio, b'V', 34, v4l2_audio);
    #[test]
    fn test_ioctl_write_ptr() {
        let file = tempfile().unwrap();
        let data: v4l2_audio = unsafe { mem::zeroed() };
        let res = unsafe { s_audio(file.as_raw_fd(), &data) };
        assert!(res == Err(Errno::ENOTTY) || res == Err(Errno::ENOSYS));
    }

    // From linux/net/bluetooth/hci_sock.h
    const HCI_IOC_MAGIC: u8 = b'H';
    const HCI_IOC_HCIDEVUP: u8 = 201;
    ioctl_write_int!(hcidevup, HCI_IOC_MAGIC, HCI_IOC_HCIDEVUP);
    #[test]
    fn test_ioctl_write_int() {
        let file = tempfile().unwrap();
        let res = unsafe { hcidevup(file.as_raw_fd(), 0) };
        assert!(res == Err(Errno::ENOTTY) || res == Err(Errno::ENOSYS));
    }

    // From linux/videodev2.h
    ioctl_read!(g_audio, b'V', 33, v4l2_audio);
    #[test]
    fn test_ioctl_read() {
        let file = tempfile().unwrap();
        let mut data: v4l2_audio = unsafe { mem::zeroed() };
        let res = unsafe { g_audio(file.as_raw_fd(), &mut data) };
        assert!(res == Err(Errno::ENOTTY) || res == Err(Errno::ENOSYS));
    }

    // From linux/videodev2.h
    ioctl_readwrite!(enum_audio,  b'V', 65, v4l2_audio);
    #[test]
    fn test_ioctl_readwrite() {
        let file = tempfile().unwrap();
        let mut data: v4l2_audio = unsafe { mem::zeroed() };
        let res = unsafe { enum_audio(file.as_raw_fd(), &mut data) };
        assert!(res == Err(Errno::ENOTTY) || res == Err(Errno::ENOSYS));
    }

    // FIXME: Find a suitable example for `ioctl_read_buf`.

    #[repr(C)]
    pub struct spi_ioc_transfer {
        tx_buf: u64,
        rx_buf: u64,
        len: u32,
        speed_hz: u32,
        delay_usecs: u16,
        bits_per_word: u8,
        cs_change: u8,
        tx_nbits: u8,
        rx_nbits: u8,
        pad: u16,
    }

    // From linux/spi/spidev.h
    ioctl_write_buf!(spi_ioc_message, super::SPI_IOC_MAGIC, super::SPI_IOC_MESSAGE, spi_ioc_transfer);
    #[test]
    fn test_ioctl_write_buf() {
        let file = tempfile().unwrap();
        let data: [spi_ioc_transfer; 4] = unsafe { mem::zeroed() };
        let res = unsafe { spi_ioc_message(file.as_raw_fd(), &data[..]) };
        assert!(res == Err(Errno::ENOTTY) || res == Err(Errno::ENOSYS));
    }

    // FIXME: Find a suitable example for `ioctl_readwrite_buf`.
}

#[cfg(target_os = "freebsd")]
mod freebsd_ioctls {
    use std::mem;
    use std::os::unix::io::AsRawFd;

    use tempfile::tempfile;
    use libc::termios;

    use nix::errno::Errno;

    // From sys/sys/ttycom.h
    const TTY_IOC_MAGIC: u8 = b't';
    const TTY_IOC_TYPE_NXCL: u8 = 14;
    const TTY_IOC_TYPE_GETA: u8 = 19;
    const TTY_IOC_TYPE_SETA: u8 = 20;

    ioctl_none!(tiocnxcl, TTY_IOC_MAGIC, TTY_IOC_TYPE_NXCL);
    #[test]
    fn test_ioctl_none() {
        let file = tempfile().unwrap();
        let res = unsafe { tiocnxcl(file.as_raw_fd()) };
        assert_eq!(res, Err(Errno::ENOTTY));
    }

    ioctl_read!(tiocgeta, TTY_IOC_MAGIC, TTY_IOC_TYPE_GETA, termios);
    #[test]
    fn test_ioctl_read() {
        let file = tempfile().unwrap();
        let mut termios = unsafe { mem::zeroed() };
        let res = unsafe { tiocgeta(file.as_raw_fd(), &mut termios) };
        assert_eq!(res, Err(Errno::ENOTTY));
    }

    ioctl_write_ptr!(tiocseta, TTY_IOC_MAGIC, TTY_IOC_TYPE_SETA, termios);
    #[test]
    fn test_ioctl_write_ptr() {
        let file = tempfile().unwrap();
        let termios: termios = unsafe { mem::zeroed() };
        let res = unsafe { tiocseta(file.as_raw_fd(), &termios) };
        assert_eq!(res, Err(Errno::ENOTTY));
    }
}