-
Notifications
You must be signed in to change notification settings - Fork 236
/
test_utils.rs
600 lines (524 loc) · 17.4 KB
/
test_utils.rs
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
/*
* The Shadow Simulator
* See LICENSE for licensing information
*/
//! Utilities helpful for writing Rust integration tests.
use std::collections::HashSet;
use std::io::Write;
use std::sync::mpsc;
use std::time::{Duration, SystemTime};
use std::{fmt, thread};
use nix::poll::PollFlags;
use nix::sys::signal;
use nix::sys::time::TimeVal;
pub mod socket_utils;
pub mod time;
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum TestEnvironment {
Shadow,
Libc,
}
pub struct ShadowTest<T, E> {
name: String,
func: Box<dyn Fn() -> Result<T, E>>,
passing: HashSet<TestEnvironment>,
}
impl<T, E> fmt::Debug for ShadowTest<T, E> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ShadowTest")
.field("name", &self.name)
.field("passing", &self.passing)
.finish()
}
}
impl<T, E> ShadowTest<T, E> {
pub fn new(
name: &str,
func: impl Fn() -> Result<T, E> + 'static,
passing: HashSet<TestEnvironment>,
) -> Self {
Self {
name: name.to_string(),
func: Box::new(func),
passing,
}
}
pub fn run(&self) -> Result<T, E> {
(self.func)()
}
pub fn name(&self) -> &str {
&self.name
}
pub fn passing(&self, environment: TestEnvironment) -> bool {
self.passing.contains(&environment)
}
}
/// Runs provided tests until failure and outputs results to stdout.
pub fn run_tests<'a, I, T: 'a, E: 'a>(tests: I, summarize: bool) -> Result<Vec<T>, E>
where
I: IntoIterator<Item = &'a ShadowTest<T, E>>,
E: std::fmt::Debug + std::fmt::Display,
{
let mut results = vec![];
for test in tests {
print!("Testing {}...", test.name());
std::io::stdout().flush().unwrap();
match test.run() {
Err(failure) => {
println!(" ✗ ({})", failure);
if !summarize {
return Err(failure);
}
}
Ok(result) => {
results.push(result);
println!(" ✓");
}
}
}
Ok(results)
}
// AsPtr and AsMutPtr traits inspired by https://stackoverflow.com/q/35885670
/// An object that can be converted to a pointer (possibly null).
pub trait AsPtr<T> {
fn as_ptr(&self) -> *const T;
}
impl<T> AsPtr<T> for Option<T> {
fn as_ptr(&self) -> *const T {
match self {
Some(ref v) => v as *const T,
None => std::ptr::null(),
}
}
}
/// An object that can be converted to a mutable pointer (possibly null).
pub trait AsMutPtr<T> {
fn as_mut_ptr(&mut self) -> *mut T;
}
impl<T> AsMutPtr<T> for Option<T> {
fn as_mut_ptr(&mut self) -> *mut T {
match self {
Some(ref mut v) => v as *mut T,
None => std::ptr::null_mut(),
}
}
}
/// Return the error message if the condition is false.
pub fn result_assert(cond: bool, message: &str) -> Result<(), String> {
if cond {
Ok(())
} else {
Err(message.to_string())
}
}
/// Return a formatted error message if `a` and `b` are unequal.
pub fn result_assert_eq<T>(a: T, b: T, message: &str) -> Result<(), String>
where
T: std::fmt::Debug + std::cmp::PartialEq,
{
if a == b {
Ok(())
} else {
Err(format!("{:?} != {:?} -- {}", a, b, message))
}
}
/// Return a formatted error message if `a` and `b` are equal.
pub fn result_assert_ne<T>(a: T, b: T, message: &str) -> Result<(), String>
where
T: std::fmt::Debug + std::cmp::PartialEq,
{
if a != b {
Ok(())
} else {
Err(format!("{:?} == {:?} -- {}", a, b, message))
}
}
/// Run the function and then close any given file descriptors, even if there was an error.
pub fn run_and_close_fds<'a, I, F, U>(fds: I, f: F) -> U
where
I: IntoIterator<Item = &'a libc::c_int>,
F: FnOnce() -> U,
{
let rv = f();
for fd in fds.into_iter() {
let rv_close = unsafe { libc::close(*fd) };
assert_eq!(rv_close, 0, "Could not close fd {}", fd);
}
rv
}
/// Get the current errno.
pub fn get_errno() -> i32 {
std::io::Error::last_os_error().raw_os_error().unwrap()
}
/// Get the message for the given errno.
pub fn get_errno_message(errno: i32) -> String {
let cstr;
unsafe {
let error_ptr = libc::strerror(errno);
cstr = std::ffi::CStr::from_ptr(error_ptr)
}
cstr.to_string_lossy().into_owned()
}
/// Assert the boolean condition is true, else print the last system error
pub fn assert_true_else_errno(cond: bool) {
assert!(cond, "{}", get_errno_message(get_errno()));
}
/// Calls check_system_call(), but automatically passes the current line number.
#[macro_export]
macro_rules! check_system_call {
($f: expr, $expected_errnos: expr $(,)?) => {
test_utils::check_system_call($f, $expected_errnos, line!());
};
}
/// Run the given function, check that the errno was expected, and return the function's return value.
pub fn check_system_call<F, J>(
f: F,
expected_errnos: &[libc::c_int],
line: u32,
) -> Result<J, String>
where
F: FnOnce() -> J,
J: std::cmp::Ord + std::convert::From<i8> + Copy + std::fmt::Display,
{
let rv = f();
let errno = get_errno();
if expected_errnos.is_empty() {
// if no error is expected (rv should be >= 0)
if rv < 0.into() {
return Err(format!(
"Expecting a non-negative return value, received {} \"{}\" [line {}]",
rv,
get_errno_message(errno),
line,
));
}
} else {
// if we expect the system call to return an error (rv should be -1)
if rv != (-1).into() {
return Err(format!(
"Expecting a return value of -1, received {} [line {}]",
rv, line
));
}
if !expected_errnos.contains(&errno) {
return Err(format!(
"Expecting errnos {:?}, received {} \"{}\" [line {}]",
expected_errnos,
errno,
get_errno_message(errno),
line,
));
}
}
Ok(rv)
}
/// Similar to the `vec!` macro, `set!` will create a `HashSet` with the given elements.
///
/// ```
/// # use test_utils::*;
/// let s = set![1, 2, 3, 1];
/// assert_eq!(s.len(), 3);
/// ```
#[macro_export]
macro_rules! set {
() => (
std::collections::HashSet::new()
);
($($x:expr),+ $(,)?) => (
([$($x),+]).iter().cloned().collect::<std::collections::HashSet<_>>()
);
}
pub fn running_in_shadow() -> bool {
// There is the same function in the C tests common code
let Ok(ld_preload) = std::env::var("LD_PRELOAD") else {
return false;
};
ld_preload.contains("libshadow_injector.so")
}
/// Returns `true` if the `POLLIN` flag is set.
pub fn is_readable(fd: libc::c_int, timeout_ms: i32) -> nix::Result<bool> {
let mut poll_fds = [nix::poll::PollFd::new(fd, PollFlags::POLLIN)];
let count = nix::poll::poll(&mut poll_fds, timeout_ms)?;
Ok(count > 0 && poll_fds[0].revents().unwrap().contains(PollFlags::POLLIN))
}
/// Returns `true` if the `POLLOUT` flag is set.
pub fn is_writable(fd: libc::c_int, timeout_ms: i32) -> nix::Result<bool> {
let mut poll_fds = [nix::poll::PollFd::new(fd, PollFlags::POLLOUT)];
let count = nix::poll::poll(&mut poll_fds, timeout_ms)?;
Ok(count > 0 && poll_fds[0].revents().unwrap().contains(PollFlags::POLLOUT))
}
/// Returns the poll event flags (the result of `poll()` with `PollFlags::all()` flags set). The
/// flags will be empty if the timeout occurred.
pub fn poll_status(fd: libc::c_int, timeout_ms: i32) -> nix::Result<PollFlags> {
let mut poll_fds = [nix::poll::PollFd::new(fd, PollFlags::all())];
let _count = nix::poll::poll(&mut poll_fds, timeout_ms)?;
Ok(poll_fds[0].revents().unwrap_or(PollFlags::empty()))
}
pub struct Interruptor {
cancellation_sender: mpsc::Sender<()>,
handle: Option<thread::JoinHandle<()>>,
}
impl Interruptor {
/// Creates an Interruptor that will send `signo` to the current thread
/// after `t` has elapsed (unless cancelled in the meantime).
pub fn new(t: Duration, signal: signal::Signal) -> Self {
let (sender, receiver) = mpsc::channel();
let tid = nix::unistd::gettid();
let handle = thread::spawn(move || {
if receiver.recv_timeout(t).is_ok() {
// Cancelled
return;
} // else Timed out.
unsafe { libc::syscall(libc::SYS_tkill, tid.as_raw(), signal as i32) };
});
Self {
cancellation_sender: sender,
handle: Some(handle),
}
}
/// Cancel the interruption.
pub fn cancel(&mut self) {
if let Some(handle) = self.handle.take() {
// Send a cancellation message. Ignore failure,
// which will happen if the thread has already exited,
// closing the receiver side of the channel.
self.cancellation_sender.send(()).ok();
handle.join().unwrap();
}
}
}
impl Drop for Interruptor {
fn drop(&mut self) {
self.cancel();
}
}
extern "C" fn nop_handler(_signo: i32) {}
pub fn nop_sig_handler() -> nix::sys::signal::SigHandler {
nix::sys::signal::SigHandler::Handler(nop_handler)
}
pub fn install_nop_signal_handler(signal: signal::Signal) -> anyhow::Result<()> {
unsafe {
nix::sys::signal::sigaction(
signal,
&nix::sys::signal::SigAction::new(
nop_sig_handler(),
nix::sys::signal::SaFlags::empty(),
nix::sys::signal::SigSet::empty(),
),
)?
};
Ok(())
}
/// Run a function that will interrupted with `SIGUSR1` after the given timeout.
pub fn interrupt_fn_exec<F>(interrupt_timeout: Duration, f: F) -> anyhow::Result<()>
where
F: FnOnce() -> anyhow::Result<()>,
{
let signo = signal::Signal::SIGUSR1;
install_nop_signal_handler(signo)?;
// Start a thread that will interrupt us after the timeout.
let interruptor = Interruptor::new(interrupt_timeout, signo);
// Run the function, which may be interrupted.
f()?;
// Cancel the interruptor, in case it hasn't already fired.
drop(interruptor);
Ok(())
}
/// Convenience wrapper around `anyhow::ensure` that generates useful error messages.
///
/// Example:
///
/// ```
/// # use test_utils::*;
/// # use anyhow::anyhow;
/// fn fn1() -> Result<(), anyhow::Error> {
/// let x = 2;
/// let y = 3;
/// ensure_ord!(x, >, y);
/// Ok(())
/// }
///
/// fn fn2() -> Result<(), anyhow::Error> {
/// return Err(anyhow!("!(2 > 3)"));
/// }
///
/// assert_eq!(format!("{}", fn1().unwrap_err()),
/// format!("{}", fn2().unwrap_err()));
/// ```
#[macro_export]
macro_rules! ensure_ord {
($lhs:expr, $ord:tt, $rhs:expr) => {
let eval_lhs = $lhs;
let eval_rhs = $rhs;
anyhow::ensure!(eval_lhs $ord eval_rhs, "!({:?} {} {:?})", eval_lhs, stringify!($ord), eval_rhs);
};
}
/// Convert a `&[u8]` to `&[i8]`. Useful when making C syscalls.
pub fn u8_to_i8_slice(s: &[u8]) -> &[i8] {
// assume that if try_from() was successful, then a direct cast would also be
assert!(s.iter().all(|x| i8::try_from(*x).is_ok()));
unsafe { std::slice::from_raw_parts(s.as_ptr() as *const i8, s.len()) }
}
/// Convert a `&[i8]` to `&[u8]`. Useful when making C syscalls.
pub fn i8_to_u8_slice(s: &[i8]) -> &[u8] {
// assume that if try_from() was successful, then a direct cast would also be
assert!(s.iter().all(|x| u8::try_from(*x).is_ok()));
unsafe { std::slice::from_raw_parts(s.as_ptr() as *const u8, s.len()) }
}
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub struct ITimer {
pub interval: TimeVal,
pub value: TimeVal,
}
impl From<libc::itimerval> for ITimer {
fn from(val: libc::itimerval) -> Self {
Self {
interval: TimeVal::from(val.it_interval),
value: TimeVal::from(val.it_value),
}
}
}
// Neither `libc` nor `nix` wrap `getitimer`.
pub fn getitimer(which: i32) -> nix::Result<ITimer> {
let mut old_value: libc::itimerval = unsafe { std::mem::zeroed() };
if unsafe { libc::syscall(libc::SYS_getitimer, which, &mut old_value as *mut _) } == -1 {
return Err(nix::errno::Errno::last());
}
Ok(old_value.into())
}
// Neither `libc` nor `nix` wrap `setitimer`.
pub fn setitimer(which: i32, new_value: &libc::itimerval) -> nix::Result<ITimer> {
let mut old_value: libc::itimerval = unsafe { std::mem::zeroed() };
if unsafe { libc::syscall(libc::SYS_setitimer, which, new_value, &mut old_value) } == -1 {
return Err(nix::errno::Errno::last());
}
Ok(old_value.into())
}
/// Convert an iterator of slices to a [`Vec`] of [`IoSlice`](std::io::IoSlice) (which "is
/// guaranteed to be ABI compatible with the `iovec` type on Unix platforms").
pub fn iov_helper<'a, I, T>(iov: I) -> Vec<std::io::IoSlice<'a>>
where
I: IntoIterator<Item = &'a T>,
T: AsRef<[u8]> + 'a + ?Sized,
{
iov.into_iter()
.map(|x| std::io::IoSlice::new(x.as_ref()))
.collect()
}
/// Convert an iterator of mutable slices to a [`Vec`] of [`IoSliceMut`](std::io::IoSliceMut) (which
/// "is guaranteed to be ABI compatible with the `iovec` type on Unix platforms").
pub fn iov_helper_mut<'a, I, T>(iov: I) -> Vec<std::io::IoSliceMut<'a>>
where
I: IntoIterator<Item = &'a mut T>,
T: AsMut<[u8]> + 'a + ?Sized,
{
iov.into_iter()
.map(|x| std::io::IoSliceMut::new(x.as_mut()))
.collect()
}
/// Encodes the order in which Linux checks the syscall args. When fuzzing syscalls and passing
/// invalid values for multiple syscall args, this ordering enables us to determine which invalid
/// arg's associated error code is expected to be returned.
#[derive(Debug, Copy, Clone, Eq, Ord, PartialEq, PartialOrd)]
pub enum FuzzOrder {
First,
Second,
Third,
Fourth,
Fifth,
Sixth,
}
/// Helps us fuzz syscalls by encoding syscall argument fuzz values and the syscall result we expect
/// from Linux.
#[derive(Debug, Copy, Clone)]
pub struct FuzzArg<T> {
/// The fuzz value to pass as an argument to a syscall.
pub value: T,
/// The expected result for passing the arg value into the syscall. If we expect the value to
/// produce an error, the expected rv and/or errno are encoded in `FuzzerError`.
pub expected_result: FuzzResult,
}
impl<T> FuzzArg<T> {
/// Create a new `FuzzArg` without manually specifying the `FuzzArg` struct.
pub fn new(value: T, expected_result: FuzzResult) -> Self {
FuzzArg::<T> {
value,
expected_result,
}
}
}
/// Encodes the expected result of a particular syscall arg.
pub type FuzzResult = Result<(), FuzzError>;
/// Encodes that a fuzz test is expected to produce a syscall error. When validating a result, the
/// syscall rv and errno are optionally verfied if provided.
#[derive(Debug, Copy, Clone, Eq, Ord, PartialEq, PartialOrd)]
pub struct FuzzError {
/// Encodes the order in which Linux checks the syscall args.
pub order: FuzzOrder,
/// If `Some`, this return value is expected as a syscall result.
pub rv: Option<libc::c_int>,
/// If `Some`, this errno value is expected as a syscall result.
pub errno: Option<libc::c_int>,
}
impl FuzzError {
/// Encode that a new syscall error with priority `order` should have occurred, optionally
/// causing return val `rv` and/or `errno` to be returned.
pub fn new(order: FuzzOrder, rv: Option<libc::c_int>, errno: Option<libc::c_int>) -> Self {
FuzzError { order, rv, errno }
}
}
/// Returns `FuzzError` items for the results where we expect errors.
pub fn filter_discard_valid(results: &[FuzzResult]) -> Vec<&FuzzError> {
results
.iter()
.filter_map(|v| match v {
Err(verify) => Some(verify),
_ => None,
})
.collect()
}
/// Check that the actual syscall retval and errno matches the expected results.
pub fn verify_syscall_result(
expected_results: Vec<FuzzResult>,
expected_success_rv: libc::c_int,
actual_rv: libc::c_int,
actual_errno: libc::c_int,
) -> anyhow::Result<()> {
// We want to ensure we have the correct error for invalid values.
let mut expected_errors = filter_discard_valid(&expected_results);
// Check the error according to the ordering defined by the caller.
expected_errors.sort();
if let Some(error) = expected_errors.first() {
// The caller encoded that this should have been error.
if let Some(expected_rv) = error.rv {
// The caller wants to validate the return value.
ensure_ord!(expected_rv, ==, actual_rv);
}
if let Some(expected_errno) = error.errno {
// The caller wants to validate the errno.
ensure_ord!(expected_errno, ==, actual_errno);
}
} else {
// The caller encoded that the syscall should have returned success.
ensure_ord!(expected_success_rv, ==, actual_rv);
}
Ok(())
}
/// Run a function and check that it returns within an expected duration.
pub fn check_fn_exec_duration<F, E>(
expected: Duration,
tolerance: Duration,
f: F,
) -> anyhow::Result<()>
where
F: FnOnce() -> Result<(), E>,
anyhow::Error: From<E>,
{
let before = SystemTime::now();
f()?;
let after = SystemTime::now();
let actual = after.duration_since(before)?;
let diff = time::duration_abs_diff(expected, actual);
ensure_ord!(diff, <=, tolerance);
Ok(())
}