limage 0.5.0

A Cargo utility for running/testing Rust-based kernels using the Limine bootloader
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

use crate::config::Config;
use anyhow::Result;
use std::{io, process, time::Duration};
use thiserror::Error;
use wait_timeout::ChildExt;

pub fn run(config: Config, is_test: bool) -> Result<i32, RunError> {
    println!("Running kernel through Qemu with profile: {}", if is_test { "test" } else { "live" });

    let mut run_command: Vec<_> = config
        .run_command
        .iter()
        .map(|arg| arg.replace("{}", &format!("{}", config.image_path.display().to_string())))
        .collect();

    if is_test {
        if config.test_no_reboot {
            run_command.push("-no-reboot".to_owned());
        }
        if let Some(args) = config.test_args {
            run_command.extend(args);
        }
    } else if let Some(args) = config.run_args {
        run_command.extend(args);
    }

    let mut command = process::Command::new(&run_command[0]);
    command.args(&run_command[1..]);

    let exit_code = if is_test {
        match handle_test_execution(&mut command, config.test_timeout.into())? {
            TestResult::Success => 0,
            TestResult::Failure => 1,
            TestResult::Timeout => {
                eprintln!("Test execution timed out");
                2
            }
        }
    } else {
        let status = command.status().map_err(|error| RunError::Io {
            context: IoErrorContext::QemuRunCommand {
                command: format!("{:?}", command),
            },
            error
        })?;
        status.code().unwrap_or(1)
    };

    Ok(exit_code)
}

enum TestResult {
    Success,
    Failure,
    Timeout,
}

fn handle_test_execution(command: &mut process::Command, timeout_secs: u64) 
        -> Result<TestResult, RunError> {
    let mut child = command.spawn().map_err(|error| RunError::Io {
        context: IoErrorContext::QemuTestCommand {
            command: format!("{:?}", command)
        },
        error,
    })?;

    let timeout = Duration::from_secs(timeout_secs);
    match child.wait_timeout(timeout)
        .map_err(context(IoErrorContext::WaitWithTimeout))? 
    {
        None => {
            child.kill().map_err(context(IoErrorContext::KillQemu))?;
            child.wait().map_err(context(IoErrorContext::WaitForQemu))?;
            Ok(TestResult::Timeout)
        }
        Some(exit_status) => {
            match exit_status.code() {
                Some(33) => Ok(TestResult::Success),  // Success exit code
                Some(0) => Ok(TestResult::Failure),   // Normal exit = test failure
                Some(_) => Ok(TestResult::Failure),   // Any other exit code = failure
                None => Err(RunError::NoQemuExitCode)
            }
        }
    }
}

#[derive(Debug, Error)]
pub enum RunError {
    #[error("Test timed out")]
    TestTimedOut,

    #[error("Failed to read QEMU exit code")]
    NoQemuExitCode,

    #[error("{context}: An I/O error occurred: {error}")]
    Io { context: IoErrorContext, error: io::Error }
}

#[derive(Debug, Error)]
pub enum IoErrorContext {
    #[error("Failed to execute QEMU run command `{command}`")]
    QemuRunCommand { command: String },

    #[error("Failed to execute QEMU test command `{command}`")]
    QemuTestCommand { command: String },

    #[error("Failed to wait with timeout")]
    WaitWithTimeout,

    #[error("Failed to kill QEMU")]
    KillQemu,

    #[error("Failed to wait for QEMU process")]
    WaitForQemu
}

fn context(context: IoErrorContext) -> impl FnOnce(io::Error) -> RunError {
    |error| RunError::Io { context, error }
}