ostool 0.31.1

A tool for operating system development
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

//! Process command construction and shell hook execution with ostool variables.

use std::{
    ffi::OsStr,
    path::{Path, PathBuf},
};

use anyhow::Context as _;

use crate::{project::variables::VariableScope, utils::Command};

/// Concrete process inputs for command construction and shell hooks.
#[derive(Clone, Debug)]
pub struct ProcessContext {
    workdir: PathBuf,
    workspace_dir: PathBuf,
    variables: VariableScope,
    kernel_elf: Option<PathBuf>,
}

impl ProcessContext {
    /// Creates a process context from invocation layout, variables, and ELF state.
    pub fn new(
        workdir: PathBuf,
        workspace_dir: PathBuf,
        variables: VariableScope,
        kernel_elf: Option<PathBuf>,
    ) -> Self {
        Self {
            workdir,
            workspace_dir,
            variables,
            kernel_elf,
        }
    }

    /// Returns the directory commands should run from.
    pub fn workdir(&self) -> &Path {
        &self.workdir
    }

    /// Returns the Cargo workspace root exposed to child processes.
    pub fn workspace_dir(&self) -> &Path {
        &self.workspace_dir
    }

    /// Returns variable-expansion inputs for command arguments and hooks.
    pub fn variables(&self) -> &VariableScope {
        &self.variables
    }

    /// Returns the active kernel ELF path exported to shell hooks.
    pub fn kernel_elf(&self) -> Option<&Path> {
        self.kernel_elf.as_deref()
    }
}

/// Creates a command that expands ostool variables in its arguments.
pub fn command<S>(program: S, context: &ProcessContext) -> Command
where
    S: AsRef<OsStr>,
{
    let variables = context.variables().clone();
    let mut command = Command::new(program, context.workdir(), move |s| {
        crate::project::variables::expand_os_value(s, &variables)
    });
    command.env(
        "WORKSPACE_FOLDER",
        context.workspace_dir().display().to_string(),
    );
    command
}

/// Runs a shell command with invocation variables and `KERNEL_ELF` environment.
pub fn shell_run_cmd(context: &ProcessContext, cmd: &str) -> anyhow::Result<()> {
    let mut command = match std::env::consts::OS {
        "windows" => {
            let mut command = command("powershell", context);
            command.arg("-Command");
            command
        }
        _ => {
            let mut command = command("sh", context);
            command.arg("-c");
            command
        }
    };

    command.arg(cmd);

    if let Some(elf) = context.kernel_elf() {
        command.env("KERNEL_ELF", elf.display().to_string());
    }

    command
        .run()
        .with_context(|| format!("failed to run shell command: {cmd}"))?;
    Ok(())
}