snare 3.4.0

Ergonomic in-process network testing on top of snare-interpose: write the code under test against std, describe the peer with a tester builder
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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
use std::cell::Cell;
use std::ffi::c_int;
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::sync::{Arc, Mutex};
use std::time::Duration;

use snare_interpose::{CompletionCall, CompletionPost, NetResult};
use windows_sys::Win32::Foundation::GetLastError;

use super::{Sock, WinNet};
use crate::HashMap;
use crate::notices::{Keys, PollSet, Settled};
use crate::readiness::{Deadline, WakeKey, readiness};
use crate::sockets::SockRec;

#[derive(Default)]
pub(super) struct State {
    ports: HashMap<usize, Arc<Port>>,
    files: HashMap<usize, (Arc<Port>, usize)>,
    next_id: u64,
    /// The pending AFD polls of each port, by port id, under their status blocks, each subscribed
    /// to its socket's record (see [`crate::notices`]).
    requests: HashMap<u64, PollSet<usize, Request>>,
    /// Requests submitted so far: each request's place in submission order.
    submitted: u64,
}

impl State {
    /// Takes every pending request `take` accepts, in submission order.
    fn take(&mut self, mut take: impl FnMut(&Request) -> bool) -> Vec<Request> {
        let mut taken = Vec::new();
        for set in self.requests.values_mut() {
            let statuses: Vec<usize> = set
                .iter()
                .filter(|(_, request)| take(request))
                .map(|(&status, _)| status)
                .collect();
            taken.extend(statuses.iter().filter_map(|status| set.remove(status)));
        }
        taken.sort_by_key(|request| request.order);
        taken
    }
}

struct Port {
    handle: usize,
    id: u64,
    post: CompletionPost,
    closed: AtomicBool,
    external: AtomicBool,
    modeled: AtomicBool,
    gate: Mutex<()>,
    generation: AtomicU64,
}

struct Request {
    file: usize,
    port: Arc<Port>,
    key: usize,
    status: usize,
    output: usize,
    context: usize,
    mask: u32,
    socket: c_int,
    rec: Arc<SockRec>,
    order: u64,
}

#[repr(C)]
struct Status {
    status: isize,
    information: usize,
}
#[repr(C)]
struct PollHandle {
    handle: usize,
    events: u32,
    status: i32,
}
#[repr(C)]
struct PollInfo {
    timeout: i64,
    count: u32,
    exclusive: u32,
    handle: PollHandle,
}

impl Request {
    unsafe fn complete(&self, events: u32, status: i32) {
        unsafe {
            let information = if status < 0 {
                std::mem::offset_of!(PollInfo, handle)
            } else {
                std::mem::size_of::<PollInfo>()
            };
            if status >= 0 {
                let info = &mut *(self.output as *mut PollInfo);
                info.handle.events = events;
                info.handle.status = 0;
            }
            *(self.status as *mut Status) = Status {
                status: status as isize,
                information,
            };
            (self.port.post)(
                self.port.handle as *mut u8,
                self.key as *mut u8,
                self.context as *mut u8,
                status,
                information,
            );
        }
    }
}

/// The socket a request polls, by the handle it named while that handle still holds it, and
/// with its handle.
fn polled<'a>(socks: &'a HashMap<c_int, Sock>, request: &Request) -> Option<(c_int, &'a Sock)> {
    let id = request.rec.id;
    socks
        .get_key_value(&request.socket)
        .filter(|(_, sock)| sock.rec().id == id)
        .or_else(|| socks.iter().find(|(_, sock)| sock.rec().id == id))
        .map(|(&fd, sock)| (fd, sock))
}

/// The AFD events `request`'s socket in `socks` shows now, and how a scan leaves the request
/// when none of them is asked for: a connect under way or a delayed arrival moves with the clock,
/// and a fresh socket may start connecting or listening with nothing bumped.
fn afd_state(socks: &HashMap<c_int, Sock>, request: &Request) -> (u32, Settled) {
    let Some((_, sock)) = polled(socks, request) else {
        return (32, Settled::Due);
    };
    let settled = if matches!(sock, Sock::Fresh { .. } | Sock::Connecting { .. })
        || request.rec.pending_time()
    {
        Settled::Timed
    } else {
        Settled::Idle
    };
    (afd_events(sock), settled)
}

fn afd_events(sock: &Sock) -> u32 {
    match sock {
        Sock::Fresh { rec, .. } if rec.peek_socket_error().is_some() => 256,
        Sock::Fresh { .. } | Sock::Connecting { .. } => 0,
        Sock::Stream { conn, end, rec, .. } => {
            let read = conn.read_pipe(*end);
            let write = conn.write_pipe(*end);
            if read.is_reset() || write.is_reset() || rec.peek_socket_error().is_some() {
                return 16;
            }
            u32::from(read.readable_or_closed())
                | (u32::from(write.writable()) * 4)
                | (u32::from(read.read_eof()) * 8)
        }
        Sock::Dgram { queue, rec, .. } => {
            u32::from(queue.has(|_| true) || rec.peek_error().is_some()) | 4
        }
        Sock::Listener { state, .. } => u32::from(!state.pending.lock().unwrap().is_empty()) * 128,
    }
}

impl WinNet {
    fn afd_events(&self, request: &Request) -> u32 {
        afd_state(&self.socks.lock().unwrap(), request).0
    }

    /// Completes the requests on `port` whose sockets now show an event they ask for, in
    /// submission order, looking only at those notices or the clock may have changed.
    fn completion_refresh(&self, port: &Port) {
        self.advance_connecting(None);
        let mut state = self.completions.lock().unwrap();
        let Some(set) = state.requests.get_mut(&port.id) else {
            return;
        };
        let due = set.due();
        if due.is_empty() {
            return;
        }
        let mut fired = Vec::new();
        {
            let socks = self.socks.lock().unwrap();
            for ticket in due {
                let Some((status, request)) = set.at(ticket) else {
                    continue;
                };
                let (events, settled) = afd_state(&socks, request);
                let events = events & request.mask;
                if events != 0 {
                    fired.push((request.order, status, events));
                } else {
                    set.settle(ticket, settled, None);
                }
            }
        }
        fired.sort_unstable_by_key(|&(order, ..)| order);
        for (_, status, events) in fired {
            if let Some(request) = set.remove(&status) {
                unsafe { request.complete(events, 0) };
            }
        }
    }

    /// Whether a wait on `port` must look again as the clock moves: one of its requests'
    /// readiness moved with time when last looked at, by a refresh or by
    /// [`completion_due`](Self::completion_due), which a wait asks first.
    fn completion_timed(&self, port: &Port) -> bool {
        self.completions
            .lock()
            .unwrap()
            .requests
            .get(&port.id)
            .is_some_and(PollSet::timed)
    }

    /// Whether a request on `port` shows an event it asks for or has a connect to move on. The
    /// requests notices listed that do neither are settled, as a refresh would leave them.
    fn completion_due(&self, port: &Port) -> bool {
        let mut state = self.completions.lock().unwrap();
        let Some(set) = state.requests.get_mut(&port.id) else {
            return false;
        };
        let due = set.due();
        let socks = self.socks.lock().unwrap();
        let mut any = false;
        for ticket in due {
            let Some((_, request)) = set.at(ticket) else {
                continue;
            };
            let (events, settled) = afd_state(&socks, request);
            let connect = polled(&socks, request).is_some_and(|(fd, sock)| {
                fd >= 0
                    && matches!(sock, Sock::Connecting { attempt, .. } if attempt.lock().unwrap().due())
            });
            if events & request.mask != 0 || connect {
                any = true;
            } else {
                set.settle(ticket, settled, None);
            }
        }
        any
    }
}

pub(super) unsafe fn call(net: &WinNet, call: CompletionCall) -> Option<NetResult> {
    match call {
        CompletionCall::Duplicate { handle } => {
            let state = net.completions.lock().unwrap();
            let port = state.ports.get(&handle)?;
            (!port.external.load(Ordering::Acquire)).then_some(NetResult::Err(50))
        }
        CompletionCall::Associate { port, afd } => {
            let state = net.completions.lock().unwrap();
            let port = state.ports.get(&port)?;
            Some(if !afd && port.modeled.load(Ordering::Acquire) {
                NetResult::Err(50)
            } else {
                NetResult::Ok(0)
            })
        }
        CompletionCall::Register {
            file,
            port,
            key,
            post,
            afd,
        } => {
            let mut state = net.completions.lock().unwrap();
            if !state.ports.contains_key(&port) {
                state.next_id += 1;
                let description = Arc::new(Port {
                    handle: port,
                    id: state.next_id,
                    post,
                    closed: AtomicBool::new(false),
                    external: AtomicBool::new(false),
                    modeled: AtomicBool::new(false),
                    gate: Mutex::new(()),
                    generation: AtomicU64::new(0),
                });
                state.ports.insert(port, description);
            }
            let description = state.ports[&port].clone();
            if file != usize::MAX {
                if !afd {
                    description.external.store(true, Ordering::Release);
                }
                state.files.entry(file).or_insert((description, key));
            }
            Some(NetResult::Ok(0))
        }
        CompletionCall::Notify { port } => {
            let port = net.completions.lock().unwrap().ports.get(&port)?.clone();
            net.regs
                .shared
                .bump_keys(&[WakeKey::CompletionPort(port.id)]);
            Some(NetResult::Ok(0))
        }
        CompletionCall::Poll {
            file,
            status,
            context,
            input,
            input_len,
            output,
            output_len,
        } => {
            if input.is_null()
                || status.is_null()
                || output.is_null()
                || input_len < std::mem::size_of::<PollInfo>() as u32
                || output_len < std::mem::size_of::<PollInfo>() as u32
            {
                return Some(NetResult::Ok(0xc000000d_u32 as i64));
            }
            let info = unsafe { &*input.cast::<PollInfo>() };
            if info.count != 1 {
                return Some(NetResult::Ok(0xc00000bb_u32 as i64));
            }
            let rec = net.rec(info.handle.handle as i32);
            let mut state = net.completions.lock().unwrap();
            let (port, key) = state.files.get(&file)?.clone();
            let Some(rec) = rec else {
                if port.modeled.load(Ordering::Acquire) {
                    return Some(NetResult::Ok(0xc00000bb_u32 as i64));
                }
                port.external.store(true, Ordering::Release);
                return None;
            };
            if info.timeout != i64::MAX
                || info.exclusive != 0
                || port.external.load(Ordering::Acquire)
            {
                return Some(NetResult::Ok(0xc00000bb_u32 as i64));
            }
            if port.closed.load(Ordering::Acquire) {
                return Some(NetResult::Ok(0xc0000008_u32 as i64));
            }
            if state
                .requests
                .values()
                .any(|set| set.contains_key(&(status as usize)))
            {
                return Some(NetResult::Ok(0xc000000d_u32 as i64));
            }
            unsafe {
                *(status.cast::<Status>()) = Status {
                    status: 0x103,
                    information: 0,
                };
            }
            port.modeled.store(true, Ordering::Release);
            state.submitted += 1;
            let request = Request {
                file,
                port: port.clone(),
                key,
                status: status as usize,
                output: output as usize,
                context,
                mask: info.handle.events,
                socket: info.handle.handle as c_int,
                rec,
                order: state.submitted,
            };
            let events = net.afd_events(&request) & request.mask;
            let completed = events != 0;
            if completed {
                unsafe { request.complete(events, 0) };
            } else {
                let keys = Keys::of(Some(request.rec.wake_key()), None);
                state
                    .requests
                    .entry(port.id)
                    .or_insert_with(|| {
                        let set = PollSet::new();
                        set.list().place(port.id, net.regs.shared.domain_key());
                        set
                    })
                    .insert(status as usize, request, keys);
            }
            port.generation.fetch_add(1, Ordering::Release);
            drop(state);
            net.regs
                .shared
                .bump_keys(&[WakeKey::CompletionPort(port.id)]);
            Some(NetResult::Ok(if completed { 0 } else { 0x103 }))
        }
        CompletionCall::Cancel {
            file,
            status,
            result,
        } => {
            let mut state = net.completions.lock().unwrap();
            if !state.files.contains_key(&file) {
                return None;
            }
            let port = state.files[&file].0.clone();
            let cancelled = state.take(|request| {
                request.file == file && (status.is_null() || request.status == status as usize)
            });
            let found = !cancelled.is_empty();
            for request in cancelled {
                unsafe {
                    request.complete(0, 0xc0000120_u32 as i32);
                }
            }
            if !found {
                return None;
            }
            if !result.is_null() {
                unsafe {
                    *result.cast::<Status>() = Status {
                        status: 0,
                        information: 0,
                    };
                }
            }
            drop(state);
            if found {
                port.generation.fetch_add(1, Ordering::Release);
                net.regs
                    .shared
                    .bump_keys(&[WakeKey::CompletionPort(port.id)]);
            }
            Some(NetResult::Ok(if found { 0 } else { 0xc0000225_u32 as i64 }))
        }
        CompletionCall::Close { handle, native } => {
            let mut state = net.completions.lock().unwrap();
            let description = state.ports.get(&handle).cloned();
            let gate = description.as_ref().map(|port| port.gate.lock().unwrap());
            let result = unsafe { native(handle as *mut u8) };
            if result == 0 {
                return Some(NetResult::Err(unsafe { GetLastError() } as i32));
            }
            let port = state.ports.remove(&handle);
            if let Some(port) = &port {
                port.closed.store(true, Ordering::Release);
            }
            let file = state.files.remove(&handle);
            let closed = state.take(|request| {
                request.file == handle
                    || port.as_ref().is_some_and(|port| port.id == request.port.id)
            });
            if let Some(port) = &port {
                state.requests.remove(&port.id);
            }
            for request in closed {
                if !request.port.closed.load(Ordering::Acquire) {
                    unsafe {
                        request.complete(0, 0xc0000120_u32 as i32);
                    }
                }
            }
            let key = port
                .or_else(|| file.map(|(port, _)| port))
                .map(|port| WakeKey::CompletionPort(port.id));
            drop(gate);
            drop(state);
            if let Some(key) = key {
                net.regs.shared.bump_keys(&[key]);
            }
            Some(NetResult::Ok(result as i64))
        }
        CompletionCall::Get {
            port,
            entries,
            count,
            removed,
            timeout,
            alertable,
            query,
        } => {
            let port = net.completions.lock().unwrap().ports.get(&port)?.clone();
            if port.external.load(Ordering::Acquire) {
                return None;
            }
            if alertable != 0 {
                return Some(NetResult::Err(50));
            }
            let deadline = (timeout != u32::MAX)
                .then(|| Deadline::timeout(Duration::from_millis(timeout as u64)));
            let observed = Cell::new(None);
            let probe = || {
                if observed.get().is_some() {
                    return true;
                }
                let _gate = port.gate.lock().unwrap();
                if port.closed.load(Ordering::Acquire) {
                    observed.set(Some(Err(735)));
                    return true;
                }
                let result =
                    unsafe { query(port.handle as *mut u8, entries, count, removed, 0, 0) };
                if result != 0 {
                    observed.set(Some(Ok(result as i64)));
                    true
                } else {
                    let error = unsafe { GetLastError() };
                    if error != 258 {
                        observed.set(Some(Err(error as i32)));
                        true
                    } else {
                        false
                    }
                }
            };
            loop {
                net.completion_refresh(&port);
                if probe() {
                    return observed.get().map(|result| match result {
                        Ok(value) => NetResult::Ok(value),
                        Err(error) => NetResult::Err(error),
                    });
                }
                if timeout == 0 || deadline.is_some_and(|deadline| deadline.passed()) {
                    return Some(NetResult::Err(258));
                }
                let generation = port.generation.load(Ordering::Acquire);
                // The port itself is asked last: a waiter a notice woke finds its request due,
                // whose completion reaches the port only from the refresh that follows, so asking
                // the port first is a system call on every such wake that cannot find it.
                if !readiness().wait_until_on(
                    "IOCP",
                    deadline,
                    &[WakeKey::CompletionPort(port.id)],
                    || net.completion_timed(&port),
                    || {
                        port.generation.load(Ordering::Acquire) != generation
                            || net.completion_due(&port)
                            || probe()
                    },
                ) {
                    return Some(NetResult::Err(258));
                }
                if observed.get().is_some() {
                    return observed.get().map(|result| match result {
                        Ok(value) => NetResult::Ok(value),
                        Err(error) => NetResult::Err(error),
                    });
                }
            }
        }
    }
}