Project Chimera
Меню

Исходники

346 строк · 16 КиБ

code/crates/chl-input/src/hotplug.rs

1//! Горячее подключение: кто появился, кто пропал, кто переехал на другой узел.
2//!
3//! Механизм намеренно повторяет StartWine — опрос `/dev/input` по таймеру,
4//! сопоставление по устойчивому имени, а не по пути или дескриптору
5//! (`sw_input.py:1293-1307`). Это выглядит примитивно рядом с подпиской на
6//! события udev через netlink, и всё же выбран опрос. Причины:
7//!
8//! 1. **Он проверен на том самом сценарии, ради которого всё делается.**
9//! Владелец выключает пад кнопкой и включает обратно посреди игры, и в
10//! StartWine это работает годами. Цикл «попробовать открыть, поймать
11//! `OSError`, вернуться к опросу» переживает любую ошибку, потому что
12//! состояния между итерациями у него нет вовсе.
13//! 2. **Подписка на udev тянет `libudev`** — системную библиотеку на C,
14//! которую пришлось бы искать при сборке. Полсотни `readdir` раз в
15//! полсекунды стоят меньше, чем эта зависимость.
16//! 3. **Netlink-события всё равно не отменяют повторного открытия по имени.**
17//! Узел `/dev/input/eventN` появляется раньше, чем udev успевает выдать
18//! ему ACL: измерено на этой машине — около 50 мс между созданием узла и
19//! правом его открыть. Значит опрос с повтором нужен в любом случае, и
20//! вопрос лишь в том, будет ли он единственным механизмом или вторым.
21//!
22//! Само сравнение снимков — чистая функция [`diff`], и проверяется она на
23//! выдуманных списках устройств, без железа. Пад для этого включать не надо.
24
25use std::time::{Duration, Instant};
26
27use crate::device::{Identity, Info, Kind};
28
29/// Как часто опрашивается `/dev/input`.
30///
31/// Полсекунды — как в StartWine. Меньше не нужно: это задержка между
32/// «включил пад» и «лаунчер это заметил», и полсекунды на таком действии
33/// человек не замечает. Больше — начинает.
34pub const DEFAULT_INTERVAL: Duration = Duration::from_millis(500);
35
36/// Что изменилось между двумя снимками.
37#[derive(Debug, Clone, PartialEq, Eq)]
38pub enum Change {
39 Connected(Info),
40 Disconnected(Identity),
41 /// То же устройство на другом узле.
42 ///
43 /// Это не редкость и не признак поломки: ядро переиспользует номера
44 /// `eventN`, и пад, выключенный и включённый обратно, часто получает
45 /// чужой номер. Ровно поэтому дескриптор и путь нельзя запоминать —
46 /// запомненный путь через минуту указывает на другое устройство.
47 Moved {
48 identity: Identity,
49 from: std::path::PathBuf,
50 to: std::path::PathBuf,
51 },
52}
53
54impl Change {
55 pub fn identity(&self) -> &Identity {
56 match self {
57 Change::Connected(info) => &info.identity,
58 Change::Disconnected(id) => id,
59 Change::Moved { identity, .. } => identity,
60 }
61 }
62}
63
64/// Сравнивает два снимка списка устройств.
65///
66/// Порядок результата детерминирован — сначала отключения, потом переезды,
67/// потом подключения, внутри каждой группы по ключу устройства. Иначе один
68/// и тот же набор изменений печатался бы каждый раз по-новому, и в тестах,
69/// и в `chl gamepad watch`.
70pub fn diff(prev: &[Info], next: &[Info]) -> Vec<Change> {
71 let mut disconnected = Vec::new();
72 let mut moved = Vec::new();
73 let mut connected = Vec::new();
74
75 for old in prev {
76 let key = old.identity.key();
77 match next.iter().find(|n| n.identity.key() == key) {
78 None => disconnected.push((key, Change::Disconnected(old.identity.clone()))),
79 Some(new) if new.path != old.path => moved.push((
80 key,
81 Change::Moved {
82 identity: new.identity.clone(),
83 from: old.path.clone(),
84 to: new.path.clone(),
85 },
86 )),
87 Some(_) => {}
88 }
89 }
90 for new in next {
91 let key = new.identity.key();
92 if !prev.iter().any(|o| o.identity.key() == key) {
93 connected.push((key, Change::Connected(new.clone())));
94 }
95 }
96
97 let mut out = Vec::new();
98 for group in [&mut disconnected, &mut moved, &mut connected] {
99 group.sort_by(|a, b| a.0.cmp(&b.0));
100 out.extend(group.drain(..).map(|(_, c)| c));
101 }
102 out
103}
104
105/// Находит текущий узел устройства по его устойчивому ключу.
106///
107/// Это тот самый примитив, ради которого сопоставление идёт по имени:
108/// «открой пад заново» после того, как его выключили и включили. Путь,
109/// сохранённый до отключения, для этого не годится.
110pub fn resolve<'a>(devices: &'a [Info], key: &str) -> Option<&'a Info> {
111 devices.iter().find(|d| d.identity.key() == key)
112}
113
114/// То же, но без привязки к разъёму — по [`Identity::family`].
115///
116/// Нужен, когда пад переподключили в другой USB-порт: физический путь стал
117/// другим, значит строгий ключ не совпадёт, а устройство то же самое.
118/// Отдавать при этом первое совпадение достаточно: разные экземпляры одной
119/// модели различаются серийным номером, и он в широкий ключ входит.
120pub fn resolve_family<'a>(devices: &'a [Info], family: &str) -> Option<&'a Info> {
121 devices.iter().find(|d| d.identity.family() == family)
122}
123
124/// Опрос `/dev/input` по таймеру с выдачей изменений.
125///
126/// Ничего не открывает на чтение потока и ничего не захватывает: каждый
127/// такт — это `readdir` плюс ioctl-описание на каждый узел, и всё.
128pub struct Watcher {
129 interval: Duration,
130 only: Option<Kind>,
131 last: Vec<Info>,
132}
133
134impl Watcher {
135 /// Наблюдатель за всеми устройствами. Первый [`Watcher::poll`] отдаст
136 /// всё подключённое как [`Change::Connected`] — так и задумано: тому,
137 /// кто подписался, нужен и текущий состав, а не только изменения.
138 pub fn new() -> Self {
139 Self {
140 interval: DEFAULT_INTERVAL,
141 only: None,
142 last: Vec::new(),
143 }
144 }
145
146 /// Только устройства одного типа. Для геймпадного слоя — [`Kind::Gamepad`].
147 pub fn only(mut self, kind: Kind) -> Self {
148 self.only = Some(kind);
149 self
150 }
151
152 pub fn interval(mut self, interval: Duration) -> Self {
153 self.interval = interval;
154 self
155 }
156
157 /// Один такт опроса. Возвращает изменения с прошлого такта.
158 pub fn poll(&mut self) -> Vec<Change> {
159 let (mut now, _skipped) = crate::device::enumerate();
160 if let Some(kind) = self.only {
161 now.retain(|d| d.kind == kind);
162 }
163 let changes = diff(&self.last, &now);
164 self.last = now;
165 changes
166 }
167
168 /// Текущий состав по последнему такту.
169 pub fn current(&self) -> &[Info] {
170 &self.last
171 }
172
173 /// Опрашивает, пока обработчик не попросит остановиться.
174 ///
175 /// `on_change` возвращает `false`, чтобы прекратить. Ошибок цикл не
176 /// возвращает вовсе, и это осознанно: исчезнувшее устройство — не
177 /// ошибка, а событие, ради которого цикл и написан.
178 pub fn run(&mut self, mut on_change: impl FnMut(&Change) -> bool) {
179 loop {
180 let started = Instant::now();
181 for change in self.poll() {
182 if !on_change(&change) {
183 return;
184 }
185 }
186 let spent = started.elapsed();
187 if spent < self.interval {
188 std::thread::sleep(self.interval - spent);
189 }
190 }
191 }
192}
193
194impl Default for Watcher {
195 fn default() -> Self {
196 Self::new()
197 }
198}
199
200#[cfg(test)]
201mod tests {
202 use super::*;
203 use std::path::PathBuf;
204
205 fn pad(name: &str, uniq: Option<&str>, path: &str) -> Info {
206 pad_at(name, uniq, path, Some("usb-0000:0f:00.0-1/input0"))
207 }
208
209 fn pad_at(name: &str, uniq: Option<&str>, path: &str, phys: Option<&str>) -> Info {
210 Info {
211 path: PathBuf::from(path),
212 identity: Identity {
213 name: name.into(),
214 vendor: 0x2dc8,
215 product: 0x3106,
216 uniq: uniq.map(str::to_string),
217 phys: phys.map(str::to_string),
218 },
219 kind: Kind::Gamepad,
220 force_feedback: true,
221 keys: 17,
222 abs_axes: 8,
223 rel_axes: 0,
224 }
225 }
226
227 #[test]
228 fn пустой_снимок_против_пустого_ничего_не_даёт() {
229 assert!(diff(&[], &[]).is_empty());
230 }
231
232 #[test]
233 fn первый_опрос_показывает_всё_подключённое() {
234 let now = vec![pad("Pad", Some("A"), "/dev/input/event20")];
235 let changes = diff(&[], &now);
236 assert_eq!(changes.len(), 1);
237 assert!(matches!(changes[0], Change::Connected(_)));
238 }
239
240 #[test]
241 fn пад_выключили_кнопкой() {
242 let before = vec![pad("Pad", Some("A"), "/dev/input/event20")];
243 let changes = diff(&before, &[]);
244 assert_eq!(changes.len(), 1);
245 assert!(matches!(&changes[0], Change::Disconnected(id) if id.name == "Pad"));
246 }
247
248 /// Тот самый сценарий, ради которого сопоставление идёт по имени:
249 /// выключил пад, включил обратно, ядро выдало другой номер узла.
250 #[test]
251 fn переподключение_на_другой_узел_это_переезд_а_не_новое_устройство() {
252 let before = vec![pad("Pad", Some("A"), "/dev/input/event20")];
253 let after = vec![pad("Pad", Some("A"), "/dev/input/event3")];
254 let changes = diff(&before, &after);
255 assert_eq!(changes.len(), 1, "{changes:?}");
256 match &changes[0] {
257 Change::Moved { from, to, .. } => {
258 assert_eq!(from, Path::new("/dev/input/event20"));
259 assert_eq!(to, Path::new("/dev/input/event3"));
260 }
261 other => panic!("ожидался переезд, получено {other:?}"),
262 }
263 }
264 use std::path::Path;
265
266 #[test]
267 fn два_одинаковых_пада_различаются_серийным_номером() {
268 let before = vec![pad("Pad", Some("A"), "/dev/input/event20")];
269 let after = vec![
270 pad("Pad", Some("A"), "/dev/input/event20"),
271 pad("Pad", Some("B"), "/dev/input/event21"),
272 ];
273 let changes = diff(&before, &after);
274 assert_eq!(changes.len(), 1);
275 assert_eq!(changes[0].identity().uniq.as_deref(), Some("B"));
276 }
277
278 /// Регрессия на живой находке: три узла одного устройства с одинаковым
279 /// названием и серийным номером-заглушкой не должны считаться одним
280 /// устройством, вечно переезжающим между узлами.
281 #[test]
282 fn интерфейсы_одного_устройства_не_дают_вечного_переезда() {
283 let devices = vec![
284 pad_at("Razer Basilisk", None, "/dev/input/event3", Some("usb-1/input0")),
285 pad_at("Razer Basilisk", None, "/dev/input/event20", Some("usb-1/input1")),
286 pad_at("Razer Basilisk", None, "/dev/input/event24", Some("usb-1/input2")),
287 ];
288 assert_eq!(diff(&[], &devices).len(), 3, "должны быть три разных устройства");
289 assert!(
290 diff(&devices, &devices).is_empty(),
291 "неизменный список не должен давать изменений"
292 );
293 }
294
295 #[test]
296 fn порядок_изменений_детерминирован() {
297 let before = vec![
298 pad("Ушёл", Some("Z"), "/dev/input/event1"),
299 pad("Переехал", Some("M"), "/dev/input/event2"),
300 ];
301 let after = vec![
302 pad("Переехал", Some("M"), "/dev/input/event9"),
303 pad("Пришёл", Some("A"), "/dev/input/event3"),
304 ];
305 let changes = diff(&before, &after);
306 assert_eq!(changes.len(), 3);
307 assert!(matches!(changes[0], Change::Disconnected(_)));
308 assert!(matches!(changes[1], Change::Moved { .. }));
309 assert!(matches!(changes[2], Change::Connected(_)));
310 assert_eq!(diff(&before, &after), changes, "повтор должен дать то же самое");
311 }
312
313 #[test]
314 fn resolve_находит_устройство_по_ключу() {
315 let devices = vec![
316 pad("Первый", Some("A"), "/dev/input/event1"),
317 pad("Второй", Some("B"), "/dev/input/event2"),
318 ];
319 let key = devices[1].identity.key();
320 assert_eq!(resolve(&devices, &key).unwrap().path, Path::new("/dev/input/event2"));
321 assert!(resolve(&devices, "uniq:нет-такого").is_none());
322 }
323
324 #[test]
325 fn resolve_после_переезда_отдаёт_новый_путь() {
326 let key = pad("Pad", Some("A"), "/dev/input/event20").identity.key();
327 let after = vec![pad("Pad", Some("A"), "/dev/input/event3")];
328 assert_eq!(resolve(&after, &key).unwrap().path, Path::new("/dev/input/event3"));
329 }
330
331 #[test]
332 fn пад_воткнутый_в_другой_разъём_находится_широким_ключом() {
333 let before = pad_at("Pad", Some("A"), "/dev/input/event20", Some("usb-1/input0"));
334 let after = vec![pad_at("Pad", Some("A"), "/dev/input/event3", Some("usb-9/input0"))];
335
336 assert!(
337 resolve(&after, &before.identity.key()).is_none(),
338 "строгий ключ включает разъём и совпасть не должен"
339 );
340 assert_eq!(
341 resolve_family(&after, &before.identity.family()).unwrap().path,
342 Path::new("/dev/input/event3")
343 );
344 }
345}
346