hidpipe 0.1.1

Pass hid devices to micro vms.
Documentation
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
use input_linux::{evdev::EvdevHandle, AbsoluteAxis, EventKind, InputProperty, Key, MiscKind};
use nix::errno::Errno;
use nix::sys::epoll::{Epoll, EpollCreateFlags, EpollEvent, EpollFlags, EpollTimeout};
use std::collections::hash_map;
use std::collections::{HashMap, HashSet};
use std::ffi::OsStr;
use std::io::{ErrorKind, Read, Result};
use std::net::Shutdown;
use std::os::fd::{AsRawFd, FromRawFd};
use std::os::unix::fs::OpenOptionsExt;
use std::os::unix::net::{UnixListener, UnixStream};
use std::{
    env,
    fs::{self, File},
    mem,
};
use udev::{EventType, MonitorBuilder};

use hidpipe::{
    empty_input_event, struct_to_socket, AddDevice, ClientHello, FFErase, FFUpload, InputEvent,
    MessageType, RemoveDevice, ServerHello,
};
use nix::unistd::getresuid;

fn is_joystick<F: AsRawFd>(evdev: &EvdevHandle<F>) -> Result<bool> {
    let props = evdev.device_properties()?;
    let no = Ok(false);
    if props.get(InputProperty::Accelerometer)
        || props.get(InputProperty::PointingStick)
        || props.get(InputProperty::TopButtonPad)
        || props.get(InputProperty::ButtonPad)
        || props.get(InputProperty::SemiMultiTouch)
    {
        return no;
    }
    let events = evdev.event_bits()?;
    if !events.get(EventKind::Absolute) {
        return no;
    }
    let axes = evdev.absolute_mask()?;
    if !axes.get(AbsoluteAxis::X) || !axes.get(AbsoluteAxis::Y) {
        return no;
    }
    let keys = evdev.key_mask()?;
    Ok(keys.get(Key::ButtonTrigger)
        || keys.get(Key::ButtonSouth)
        || keys.get(Key::Button1)
        || axes.get(AbsoluteAxis::RX)
        || axes.get(AbsoluteAxis::RY)
        || axes.get(AbsoluteAxis::Throttle)
        || axes.get(AbsoluteAxis::Rudder)
        || axes.get(AbsoluteAxis::Wheel)
        || axes.get(AbsoluteAxis::Gas)
        || axes.get(AbsoluteAxis::Brake))
}

fn send_add_device<F: AsRawFd>(evdev: &EvdevHandle<F>, client: &mut Client) -> Result<()> {
    let abs = evdev.absolute_bits()?;
    let evbits = *evdev.event_bits()?.data();
    let keybits = *evdev.key_bits()?.data();
    let relbits = *evdev.relative_bits()?.data();
    let absbits = *abs.data();
    let mut mscbits = evdev.misc_bits()?;
    mscbits.remove(MiscKind::Scancode);
    let mscbits = *mscbits.data();
    let ledbits = *evdev.led_bits()?.data();
    let sndbits = *evdev.sound_bits()?.data();
    let swbits = *evdev.switch_bits()?.data();
    let propbits = *evdev.device_properties()?.data();
    let ffbits = *evdev.force_feedback_bits()?.data();
    let input_id = evdev.device_id()?;
    let ff_effects = evdev.effects_count()? as u32;
    let id = evdev.as_raw_fd() as u64;
    let mut name = [0; 80];
    evdev.device_name_buf(&mut name)?;
    client.write(&MessageType::AddDevice)?;
    client.write(&AddDevice {
        evbits,
        keybits,
        relbits,
        absbits,
        mscbits,
        ledbits,
        id,
        sndbits,
        swbits,
        propbits,
        input_id,
        name,
        ff_effects,
        ffbits,
    })?;
    for bit in abs.iter() {
        let info = evdev.absolute_info(bit)?;
        client.write(&info)?;
    }
    Ok(())
}

struct EvdevContainer {
    fds_to_devs: HashMap<u64, EvdevHandle<File>>,
    names_to_fds: HashMap<String, u64>,
}

fn insert_entry<K, V>(entry: hash_map::Entry<K, V>, v: V) -> &V {
    match entry {
        hash_map::Entry::Vacant(e) => e.insert(v),
        hash_map::Entry::Occupied(mut e) => {
            e.insert(v);
            e.into_mut()
        }
    }
}

impl EvdevContainer {
    fn new() -> EvdevContainer {
        EvdevContainer {
            fds_to_devs: HashMap::new(),
            names_to_fds: HashMap::new(),
        }
    }
    fn check_and_add(
        &mut self,
        dev_name: &OsStr,
        file_name: &OsStr,
        epoll: &Epoll,
    ) -> Result<Option<&EvdevHandle<File>>> {
        let dev_name = dev_name.to_string_lossy();
        if !dev_name.starts_with("event") {
            return Ok(None);
        }
        let file = File::options()
            .read(true)
            .write(true)
            .custom_flags(libc::O_NONBLOCK)
            .open(file_name)?;
        let evdev = EvdevHandle::new(file);
        if is_joystick(&evdev)? {
            let raw = evdev.as_raw_fd() as u64;
            self.names_to_fds.insert(dev_name.into_owned(), raw);
            epoll
                .add(evdev.as_inner(), EpollEvent::new(EpollFlags::EPOLLIN, raw))
                .unwrap();
            Ok(Some(insert_entry(self.fds_to_devs.entry(raw), evdev)))
        } else {
            Ok(None)
        }
    }
    fn remove(&mut self, dev_name: &OsStr, epoll: &Epoll) -> Option<u64> {
        if let Some(id) = self
            .names_to_fds
            .remove(dev_name.to_string_lossy().as_ref())
        {
            let evdev = self.fds_to_devs.remove(&id).unwrap();
            epoll.delete(evdev.as_inner()).unwrap();
            Some(id)
        } else {
            None
        }
    }
    fn get(&self, id: u64) -> Option<&EvdevHandle<File>> {
        self.fds_to_devs.get(&id)
    }
    fn iter(&self) -> impl Iterator<Item = &EvdevHandle<File>> {
        self.fds_to_devs.values()
    }
}

#[derive(PartialEq, Eq)]
enum WaitingFor {
    Hello,
    Header,
    InputEvent,
    FFUpload,
    FFErase,
}

struct Client {
    socket: UnixStream,
    buf: Vec<u8>,
    filled: usize,
    waiting_for: WaitingFor,
}

enum ReadReply {
    Data(Vec<u8>),
    NotReady,
    Hangup,
}

impl Client {
    fn new(socket: UnixStream) -> Client {
        Client {
            socket,
            waiting_for: WaitingFor::Hello,
            buf: Vec::new(),
            filled: 0,
        }
    }
    fn read(&mut self, size: usize) -> Result<ReadReply> {
        if self.buf.is_empty() {
            self.buf.resize(size, 0);
        } else if self.buf.len() != size {
            panic!("api misuse");
        }
        let read = self.socket.read(&mut self.buf[self.filled..])?;
        if read == 0 {
            return Ok(ReadReply::Hangup);
        }
        self.filled += read;
        Ok(if self.filled == size {
            let mut ret = Vec::new();
            mem::swap(&mut self.buf, &mut ret);
            self.filled = 0;
            ReadReply::Data(ret)
        } else {
            ReadReply::NotReady
        })
    }
    fn write<T>(&mut self, data: &T) -> Result<()> {
        struct_to_socket(&mut self.socket, data)
    }
}

fn recv_from_client(
    clients: &mut HashMap<u64, Client>,
    epoll: &Epoll,
    fd: u64,
    size: usize,
) -> Option<Vec<u8>> {
    let client = clients.get_mut(&fd).unwrap();
    match client.read(size) {
        Ok(ReadReply::NotReady) => None,
        Ok(ReadReply::Data(data)) => Some(data),
        Ok(ReadReply::Hangup) => {
            epoll.delete(&client.socket).unwrap();
            clients.remove(&fd);
            None
        }
        Err(e) => {
            eprintln!("Client {} disconnected with error: {:?}", fd, e);
            epoll.delete(&client.socket).unwrap();
            clients.remove(&fd);
            None
        }
    }
}

fn hangup_on_error_bcast<F>(clients: &mut HashMap<u64, Client>, epoll: &Epoll, mut f: F)
where
    F: FnMut(&mut Client) -> Result<()>,
{
    clients.retain(|k, v| {
        if v.waiting_for == WaitingFor::Hello {
            return true;
        }
        let res = f(v);
        if res.is_err() {
            eprintln!(
                "Client {} disconnected with error: {:?}",
                *k,
                res.unwrap_err()
            );
            epoll.delete(&v.socket).unwrap();
            false
        } else {
            true
        }
    });
}

fn hangup_on_error<F>(clients: &mut HashMap<u64, Client>, epoll: &Epoll, fd: u64, f: F)
where
    F: FnOnce(&mut Client) -> Result<()>,
{
    let client = clients.get_mut(&fd).unwrap();
    let res = f(client);
    if res.is_err() {
        eprintln!(
            "Client {} disconnected with error: {:?}",
            fd,
            res.unwrap_err()
        );
        epoll.delete(&client.socket).unwrap();
        clients.remove(&fd);
    }
}

fn main() {
    if getresuid().unwrap().real.is_root() {
        eprintln!("You are trying to run hidpipe as root. Unless your entire desktop session runs as root, this is most likely not what you want.")
    }
    let udev_socket = MonitorBuilder::new()
        .unwrap()
        .match_subsystem("input")
        .unwrap()
        .listen()
        .unwrap();
    let mut evdevs = EvdevContainer::new();
    let mut clients = HashMap::new();
    let epoll = Epoll::new(EpollCreateFlags::empty()).unwrap();
    for dir_ent in fs::read_dir("/dev/input/").unwrap() {
        let dir_ent = dir_ent.unwrap();
        if dir_ent.file_type().unwrap().is_dir() {
            continue;
        }
        let name = dir_ent.file_name();
        let res = evdevs.check_and_add(&name, dir_ent.path().as_os_str(), &epoll);
        match res {
            Ok(Some(_)) => eprintln!("{} is a joystick", name.to_string_lossy()),
            Ok(None) => eprintln!("{} is not a joystick", name.to_string_lossy()),
            Err(e) if e.kind() == ErrorKind::PermissionDenied => eprintln!(
                "Unable to access {}, this is most likely fine",
                name.to_string_lossy()
            ),
            Err(e) => eprintln!(
                "Unable to determine if {} is a joystick, error: {:?}",
                name.to_string_lossy(),
                e
            ),
        }
    }
    epoll
        .add(
            &udev_socket,
            EpollEvent::new(EpollFlags::EPOLLIN, udev_socket.as_raw_fd() as u64),
        )
        .unwrap();
    let xdg_dir = env::var("XDG_RUNTIME_DIR");
    if xdg_dir.is_err() {
        eprintln!(
            "Unable to get XDG_RUNTIME_DIR, error: {:?}",
            xdg_dir.unwrap_err()
        );
        return;
    }
    let sock_path = format!("{}/hidpipe", xdg_dir.unwrap());
    _ = fs::remove_file(&sock_path);
    let listen_sock = if env::var("$LISTEN_FDS")
        .map(|x| x.parse::<u32>().unwrap() > 1)
        .unwrap_or_default()
    {
        unsafe { UnixListener::from_raw_fd(3) }
    } else {
        UnixListener::bind(sock_path).unwrap()
    };
    epoll
        .add(
            &listen_sock,
            EpollEvent::new(EpollFlags::EPOLLIN, listen_sock.as_raw_fd() as u64),
        )
        .unwrap();
    let mut seen_effect = HashSet::new();

    loop {
        let mut evts = [EpollEvent::empty()];
        match epoll.wait(&mut evts, EpollTimeout::NONE) {
            Err(Errno::EINTR) | Ok(0) => {
                continue;
            }
            Ok(_) => {}
            e => {
                e.unwrap();
            }
        }
        let fd = evts[0].data();
        if fd == udev_socket.as_raw_fd() as u64 {
            for event in udev_socket.iter() {
                match event.event_type() {
                    EventType::Remove => {
                        if let Some(id) = evdevs.remove(event.sysname(), &epoll) {
                            hangup_on_error_bcast(&mut clients, &epoll, |client| {
                                client.write(&MessageType::RemoveDevice)?;
                                client.write(&RemoveDevice { id })
                            });
                        }
                    }
                    EventType::Add => {
                        let name = event.sysname();
                        let node = event.devnode();
                        if node.is_none() {
                            continue;
                        }
                        let res = evdevs.check_and_add(name, node.unwrap().as_os_str(), &epoll);
                        match res {
                            Err(e) => {
                                eprintln!(
                                    "Unable to determine if {} is a joystick, error: {:?}",
                                    name.to_string_lossy(),
                                    e
                                );
                            }
                            Ok(None) => {}
                            Ok(Some(dev)) => {
                                hangup_on_error_bcast(&mut clients, &epoll, |client| {
                                    send_add_device(dev, client)
                                });
                            }
                        }
                    }
                    _ => {}
                }
            }
        } else if fd == listen_sock.as_raw_fd() as u64 {
            let res = listen_sock.accept();
            if res.is_err() {
                eprintln!(
                    "Failed to accept a connection, error: {:?}",
                    res.unwrap_err()
                );
                continue;
            }
            let stream = res.unwrap().0;
            stream.set_nonblocking(true).unwrap();
            let raw = stream.as_raw_fd() as u64;
            epoll
                .add(&stream, EpollEvent::new(EpollFlags::EPOLLIN, raw))
                .unwrap();
            let client = Client::new(stream);
            clients.insert(raw, client);
        } else if let Some(client) = clients.get(&fd) {
            if client.waiting_for == WaitingFor::Hello {
                let data =
                    recv_from_client(&mut clients, &epoll, fd, mem::size_of::<ClientHello>());
                if data.is_none() {
                    continue;
                }
                hangup_on_error(&mut clients, &epoll, fd, |client| {
                    client.write(&ServerHello { version: 0 })?;
                    for dev in evdevs.iter() {
                        send_add_device(dev, client)?;
                    }
                    client.waiting_for = WaitingFor::Header;
                    Ok(())
                });
            } else if client.waiting_for == WaitingFor::Header {
                let data =
                    recv_from_client(&mut clients, &epoll, fd, mem::size_of::<MessageType>());
                if data.is_none() {
                    continue;
                }
                let data = data.unwrap();
                let msg_type = u32::from_ne_bytes(data.try_into().unwrap());
                let client = clients.get_mut(&fd).unwrap();
                if msg_type == MessageType::InputEvent as u32 {
                    client.waiting_for = WaitingFor::InputEvent;
                } else if msg_type == MessageType::FFUpload as u32 {
                    client.waiting_for = WaitingFor::FFUpload;
                } else if msg_type == MessageType::FFErase as u32 {
                    client.waiting_for = WaitingFor::FFErase;
                } else {
                    eprintln!("Unknown message {} from client {}", msg_type, fd);
                    client.socket.shutdown(Shutdown::Both).unwrap();
                    continue;
                }
            } else if client.waiting_for == WaitingFor::InputEvent {
                let data = recv_from_client(&mut clients, &epoll, fd, mem::size_of::<InputEvent>());
                if data.is_none() {
                    continue;
                }
                let data = data.unwrap();
                let event = unsafe { (data.as_ptr() as *const InputEvent).as_ref().unwrap() };
                let evdev = evdevs.get(event.id);
                if evdev.is_none() {
                    eprintln!("Client {} sent input to unknown device {}", fd, event.id);
                    continue;
                }
                evdev.unwrap().write(&[event.to_input_event()]).unwrap();
                clients.get_mut(&fd).unwrap().waiting_for = WaitingFor::Header;
            } else if client.waiting_for == WaitingFor::FFUpload {
                let data = recv_from_client(&mut clients, &epoll, fd, mem::size_of::<FFUpload>());
                if data.is_none() {
                    continue;
                }
                let mut data = data.unwrap();
                let upload = unsafe { (data.as_mut_ptr() as *mut FFUpload).as_mut().unwrap() };
                let evdev = evdevs.get(upload.id);
                if evdev.is_none() {
                    eprintln!("Client {} sent input to unknown device {}", fd, upload.id);
                    continue;
                }
                if seen_effect.insert((upload.id, upload.effect.id)) {
                    upload.effect.id = -1;
                }
                evdev
                    .unwrap()
                    .send_force_feedback(&mut upload.effect)
                    .unwrap();
                hangup_on_error(&mut clients, &epoll, fd, |client| {
                    client.waiting_for = WaitingFor::Header;
                    client.write(&MessageType::FFUpload)?;
                    client.write(upload)
                });
            } else if client.waiting_for == WaitingFor::FFErase {
                let data = recv_from_client(&mut clients, &epoll, fd, mem::size_of::<FFErase>());
                if data.is_none() {
                    continue;
                }
                let mut data = data.unwrap();
                let erase = unsafe { (data.as_mut_ptr() as *const FFErase).as_ref().unwrap() };
                let evdev = evdevs.get(erase.id);
                if evdev.is_none() {
                    eprintln!("Client {} sent input to unknown device {}", fd, erase.id);
                    continue;
                }
                let effect_id = erase.effect_id as i16;
                seen_effect.remove(&(erase.id, effect_id));
                evdev.unwrap().erase_force_feedback(effect_id).unwrap();
                hangup_on_error(&mut clients, &epoll, fd, |client| {
                    client.waiting_for = WaitingFor::Header;
                    client.write(&MessageType::FFErase)?;
                    client.write(erase)
                });
            }
        } else if let Some(evdev) = evdevs.get(fd) {
            let mut evts = [empty_input_event()];
            while let Ok(count) = evdev.read(&mut evts) {
                if count == 0 {
                    break;
                }
                if evts[0].type_ == EventKind::ForceFeedback as u16 {
                    continue;
                }
                let ev = InputEvent::new(fd, evts[0]);
                hangup_on_error_bcast(&mut clients, &epoll, |client| {
                    client.write(&MessageType::InputEvent)?;
                    client.write(&ev)
                });
            }
        }
    }
}