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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
use crate::compat::{input_event, input_id, uinput_abs_setup, uinput_setup, UINPUT_MAX_NAME_SIZE};
use crate::constants::{EventType, UInputEventType};
use crate::ff::FFEffectData;
use crate::inputid::{BusType, InputId};
use crate::raw_stream::vec_spare_capacity_mut;
use crate::{
sys, AttributeSetRef, Error, FFEffectType, InputEvent, InputEventKind, Key, MiscType, PropType,
RelativeAxisType, SwitchType, UinputAbsSetup,
};
use std::fs::{File, OpenOptions};
use std::io::{self, Write};
use std::os::unix::io::AsRawFd;
use std::os::unix::prelude::RawFd;
use std::path::PathBuf;
use std::time::SystemTime;
const UINPUT_PATH: &str = "/dev/uinput";
const SYSFS_PATH: &str = "/sys/devices/virtual/input";
#[derive(Debug)]
pub struct VirtualDeviceBuilder<'a> {
file: File,
name: &'a [u8],
id: Option<input_id>,
ff_effects_max: u32,
}
impl<'a> VirtualDeviceBuilder<'a> {
pub fn new() -> io::Result<Self> {
let mut options = OpenOptions::new();
let file = options.read(true).write(true).open(UINPUT_PATH)?;
Ok(VirtualDeviceBuilder {
file,
name: Default::default(),
id: None,
ff_effects_max: 0,
})
}
#[inline]
pub fn name<S: AsRef<[u8]> + ?Sized>(mut self, name: &'a S) -> Self {
self.name = name.as_ref();
self
}
#[inline]
pub fn input_id(mut self, id: InputId) -> Self {
self.id = Some(id.0);
self
}
pub fn with_keys(self, keys: &AttributeSetRef<Key>) -> io::Result<Self> {
unsafe {
sys::ui_set_evbit(
self.file.as_raw_fd(),
crate::EventType::KEY.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
for bit in keys.iter() {
unsafe {
sys::ui_set_keybit(
self.file.as_raw_fd(),
bit.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
}
Ok(self)
}
pub fn with_absolute_axis(self, axis: &UinputAbsSetup) -> io::Result<Self> {
unsafe {
sys::ui_set_evbit(
self.file.as_raw_fd(),
crate::EventType::ABSOLUTE.0 as nix::sys::ioctl::ioctl_param_type,
)?;
sys::ui_set_absbit(
self.file.as_raw_fd(),
axis.code() as nix::sys::ioctl::ioctl_param_type,
)?;
sys::ui_abs_setup(self.file.as_raw_fd(), &axis.0 as *const uinput_abs_setup)?;
}
Ok(self)
}
pub fn with_relative_axes(self, axes: &AttributeSetRef<RelativeAxisType>) -> io::Result<Self> {
unsafe {
sys::ui_set_evbit(
self.file.as_raw_fd(),
crate::EventType::RELATIVE.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
for bit in axes.iter() {
unsafe {
sys::ui_set_relbit(
self.file.as_raw_fd(),
bit.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
}
Ok(self)
}
pub fn with_properties(self, switches: &AttributeSetRef<PropType>) -> io::Result<Self> {
for bit in switches.iter() {
unsafe {
sys::ui_set_propbit(
self.file.as_raw_fd(),
bit.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
}
Ok(self)
}
pub fn with_switches(self, switches: &AttributeSetRef<SwitchType>) -> io::Result<Self> {
unsafe {
sys::ui_set_evbit(
self.file.as_raw_fd(),
crate::EventType::SWITCH.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
for bit in switches.iter() {
unsafe {
sys::ui_set_swbit(
self.file.as_raw_fd(),
bit.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
}
Ok(self)
}
pub fn with_ff(self, ff: &AttributeSetRef<FFEffectType>) -> io::Result<Self> {
unsafe {
sys::ui_set_evbit(
self.file.as_raw_fd(),
crate::EventType::FORCEFEEDBACK.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
for bit in ff.iter() {
unsafe {
sys::ui_set_ffbit(
self.file.as_raw_fd(),
bit.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
}
Ok(self)
}
pub fn with_ff_effects_max(mut self, ff_effects_max: u32) -> Self {
self.ff_effects_max = ff_effects_max;
self
}
pub fn with_msc(self, misc_set: &AttributeSetRef<MiscType>) -> io::Result<Self> {
unsafe {
sys::ui_set_evbit(
self.file.as_raw_fd(),
crate::EventType::MISC.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
for bit in misc_set.iter() {
unsafe {
sys::ui_set_mscbit(
self.file.as_raw_fd(),
bit.0 as nix::sys::ioctl::ioctl_param_type,
)?;
}
}
Ok(self)
}
pub fn build(self) -> io::Result<VirtualDevice> {
let mut usetup = uinput_setup {
id: self.id.unwrap_or(DEFAULT_ID),
name: [0; UINPUT_MAX_NAME_SIZE],
ff_effects_max: self.ff_effects_max,
};
let name_bytes = unsafe { &*(self.name as *const [u8] as *const [libc::c_char]) };
assert!(name_bytes.len() + 1 < UINPUT_MAX_NAME_SIZE);
usetup.name[..name_bytes.len()].copy_from_slice(name_bytes);
VirtualDevice::new(self.file, &usetup)
}
}
const DEFAULT_ID: input_id = input_id {
bustype: BusType::BUS_USB.0,
vendor: 0x1234, product: 0x5678, version: 0x111,
};
pub struct VirtualDevice {
file: File,
pub(crate) event_buf: Vec<input_event>,
}
impl VirtualDevice {
fn new(file: File, usetup: &uinput_setup) -> io::Result<Self> {
unsafe { sys::ui_dev_setup(file.as_raw_fd(), usetup)? };
unsafe { sys::ui_dev_create(file.as_raw_fd())? };
Ok(VirtualDevice {
file,
event_buf: vec![],
})
}
#[inline]
fn write_raw(&mut self, messages: &[InputEvent]) -> io::Result<()> {
let bytes = unsafe { crate::cast_to_bytes(messages) };
self.file.write_all(bytes)
}
pub fn get_syspath(&mut self) -> io::Result<PathBuf> {
let mut bytes = vec![0u8; 256];
unsafe { sys::ui_get_sysname(self.file.as_raw_fd(), &mut bytes)? };
if let Some(end) = bytes.iter().position(|c| *c == 0) {
bytes.truncate(end);
}
let s = String::from_utf8_lossy(&bytes).into_owned();
let mut path = PathBuf::from(SYSFS_PATH);
path.push(s);
Ok(path)
}
pub fn enumerate_dev_nodes_blocking(&mut self) -> io::Result<DevNodesBlocking> {
let path = self.get_syspath()?;
let dir = std::fs::read_dir(path)?;
Ok(DevNodesBlocking { dir })
}
#[cfg(feature = "tokio")]
pub async fn enumerate_dev_nodes(&mut self) -> io::Result<DevNodes> {
let path = self.get_syspath()?;
let dir = tokio_1::fs::read_dir(path).await?;
Ok(DevNodes { dir })
}
pub fn emit(&mut self, messages: &[InputEvent]) -> io::Result<()> {
self.write_raw(messages)?;
let syn = InputEvent::new(EventType::SYNCHRONIZATION, 0, 0);
self.write_raw(&[syn])
}
pub fn process_ff_upload(&mut self, event: UInputEvent) -> Result<FFUploadEvent, Error> {
if event.kind() != InputEventKind::UInput(UInputEventType::UI_FF_UPLOAD.0) {
return Err(Error::InvalidEvent);
}
let mut request: sys::uinput_ff_upload = unsafe { std::mem::zeroed() };
request.request_id = event.value() as u32;
unsafe { sys::ui_begin_ff_upload(self.file.as_raw_fd(), &mut request)? };
request.retval = 0;
let file = self.file.try_clone()?;
Ok(FFUploadEvent { file, request })
}
pub fn process_ff_erase(&mut self, event: UInputEvent) -> Result<FFEraseEvent, Error> {
if event.kind() != InputEventKind::UInput(UInputEventType::UI_FF_ERASE.0) {
return Err(Error::InvalidEvent);
}
let mut request: sys::uinput_ff_erase = unsafe { std::mem::zeroed() };
request.request_id = event.value() as u32;
unsafe { sys::ui_begin_ff_erase(self.file.as_raw_fd(), &mut request)? };
request.retval = 0;
let file = self.file.try_clone()?;
Ok(FFEraseEvent { file, request })
}
pub(crate) fn fill_events(&mut self) -> io::Result<usize> {
let fd = self.file.as_raw_fd();
self.event_buf.reserve(crate::EVENT_BATCH_SIZE);
let spare_capacity = vec_spare_capacity_mut(&mut self.event_buf);
let spare_capacity_size = std::mem::size_of_val(spare_capacity);
let res = unsafe { libc::read(fd, spare_capacity.as_mut_ptr() as _, spare_capacity_size) };
let bytes_read = nix::errno::Errno::result(res)?;
let num_read = bytes_read as usize / std::mem::size_of::<input_event>();
unsafe {
let len = self.event_buf.len();
self.event_buf.set_len(len + num_read);
}
Ok(num_read)
}
pub fn fetch_events(&mut self) -> io::Result<impl Iterator<Item = UInputEvent> + '_> {
self.fill_events()?;
Ok(self.event_buf.drain(..).map(InputEvent).map(UInputEvent))
}
#[cfg(feature = "tokio")]
#[inline]
pub fn into_event_stream(self) -> io::Result<VirtualEventStream> {
VirtualEventStream::new(self)
}
}
pub struct DevNodesBlocking {
dir: std::fs::ReadDir,
}
impl Iterator for DevNodesBlocking {
type Item = io::Result<PathBuf>;
fn next(&mut self) -> Option<Self::Item> {
for entry in self.dir.by_ref() {
let entry = match entry {
Ok(entry) => entry,
Err(e) => return Some(Err(e)),
};
if !entry.file_name().to_string_lossy().starts_with("event") {
continue;
}
return Some(Ok(entry.path()));
}
None
}
}
#[cfg(feature = "tokio")]
pub struct DevNodes {
dir: tokio_1::fs::ReadDir,
}
#[cfg(feature = "tokio")]
impl DevNodes {
pub async fn next_entry(&mut self) -> io::Result<Option<PathBuf>> {
while let Some(entry) = self.dir.next_entry().await? {
if !entry.file_name().to_string_lossy().starts_with("event") {
continue;
}
return Ok(Some(entry.path()));
}
Ok(None)
}
}
impl AsRawFd for VirtualDevice {
fn as_raw_fd(&self) -> RawFd {
self.file.as_raw_fd()
}
}
#[derive(Debug)]
pub struct UInputEvent(InputEvent);
impl UInputEvent {
#[inline]
pub fn timestamp(&self) -> SystemTime {
self.0.timestamp()
}
#[inline]
pub fn event_type(&self) -> EventType {
self.0.event_type()
}
#[inline]
pub fn code(&self) -> u16 {
self.0.code()
}
#[inline]
pub fn kind(&self) -> InputEventKind {
self.0.kind()
}
#[inline]
pub fn value(&self) -> i32 {
self.0.value()
}
}
pub struct FFUploadEvent {
file: File,
request: sys::uinput_ff_upload,
}
impl FFUploadEvent {
pub fn old_effect(&self) -> FFEffectData {
self.request.old.into()
}
pub fn effect_id(&self) -> i16 {
self.request.effect.id
}
pub fn set_effect_id(&mut self, id: i16) {
self.request.effect.id = id;
}
pub fn effect(&self) -> FFEffectData {
self.request.effect.into()
}
pub fn retval(&self) -> i32 {
self.request.retval
}
pub fn set_retval(&mut self, value: i32) {
self.request.retval = value;
}
}
impl Drop for FFUploadEvent {
fn drop(&mut self) {
unsafe {
let _ = sys::ui_end_ff_upload(self.file.as_raw_fd(), &self.request);
}
}
}
pub struct FFEraseEvent {
file: File,
request: sys::uinput_ff_erase,
}
impl FFEraseEvent {
pub fn effect_id(&self) -> u32 {
self.request.effect_id
}
pub fn retval(&self) -> i32 {
self.request.retval
}
pub fn set_retval(&mut self, value: i32) {
self.request.retval = value;
}
}
impl Drop for FFEraseEvent {
fn drop(&mut self) {
unsafe {
let _ = sys::ui_end_ff_erase(self.file.as_raw_fd(), &self.request);
}
}
}
#[cfg(feature = "tokio")]
mod tokio_stream {
use super::*;
use tokio_1 as tokio;
use crate::raw_stream::poll_fn;
use futures_core::{ready, Stream};
use std::pin::Pin;
use std::task::{Context, Poll};
use tokio::io::unix::AsyncFd;
pub struct VirtualEventStream {
device: AsyncFd<VirtualDevice>,
index: usize,
}
impl Unpin for VirtualEventStream {}
impl VirtualEventStream {
pub(crate) fn new(device: VirtualDevice) -> io::Result<Self> {
use nix::fcntl;
fcntl::fcntl(device.as_raw_fd(), fcntl::F_SETFL(fcntl::OFlag::O_NONBLOCK))?;
let device = AsyncFd::new(device)?;
Ok(Self { device, index: 0 })
}
pub fn device(&self) -> &VirtualDevice {
self.device.get_ref()
}
pub fn device_mut(&mut self) -> &mut VirtualDevice {
self.device.get_mut()
}
pub async fn next_event(&mut self) -> io::Result<UInputEvent> {
poll_fn(|cx| self.poll_event(cx)).await
}
pub fn poll_event(&mut self, cx: &mut Context<'_>) -> Poll<io::Result<UInputEvent>> {
'outer: loop {
if let Some(&ev) = self.device.get_ref().event_buf.get(self.index) {
self.index += 1;
return Poll::Ready(Ok(UInputEvent(InputEvent(ev))));
}
self.device.get_mut().event_buf.clear();
self.index = 0;
loop {
let mut guard = ready!(self.device.poll_read_ready_mut(cx))?;
let res = guard.try_io(|device| device.get_mut().fill_events());
match res {
Ok(res) => {
let _ = res?;
continue 'outer;
}
Err(_would_block) => continue,
}
}
}
}
}
impl Stream for VirtualEventStream {
type Item = io::Result<UInputEvent>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
self.get_mut().poll_event(cx).map(Some)
}
}
}
#[cfg(feature = "tokio")]
pub use tokio_stream::VirtualEventStream;