ostool 0.23.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
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

//! Artifact state shared by build orchestration and runners.

use std::collections::BTreeMap;
use std::path::{Path, PathBuf};

use anyhow::anyhow;

use crate::artifact::runtime::PreparedRuntimeArtifacts;

/// Runtime artifacts prepared from a build output.
#[derive(Default, Clone, Debug)]
pub struct OutputArtifacts {
    cargo: Option<CargoArtifactState>,
    runtime: RuntimeArtifactState,
    #[allow(dead_code)]
    debug: DebugArtifactRegistry,
}

#[derive(Clone, Debug)]
struct CargoArtifactState {
    #[allow(dead_code)]
    elf: PathBuf,
    artifact_dir: PathBuf,
}

#[derive(Default, Clone, Debug)]
struct RuntimeArtifactState {
    elf: Option<PathBuf>,
    bin: Option<PathBuf>,
    artifact_dir: Option<PathBuf>,
    source_artifact_dir: Option<PathBuf>,
}

#[allow(dead_code)]
#[derive(Default, Clone, Debug)]
pub(crate) struct DebugArtifactRegistry {
    artifacts: BTreeMap<DebugArtifactKind, DebugArtifact>,
}

#[allow(dead_code)]
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) struct DebugArtifact {
    kind: DebugArtifactKind,
    path: PathBuf,
}

#[allow(dead_code)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub(crate) enum DebugArtifactKind {
    Disassembly,
    ElfInfo,
    Symbols,
}

#[allow(dead_code)]
impl DebugArtifactRegistry {
    pub(crate) fn is_empty(&self) -> bool {
        self.artifacts.is_empty()
    }

    pub(crate) fn register(&mut self, kind: DebugArtifactKind, path: PathBuf) {
        self.artifacts.insert(kind, DebugArtifact { kind, path });
    }

    pub(crate) fn get(&self, kind: DebugArtifactKind) -> Option<&Path> {
        self.artifacts
            .get(&kind)
            .map(|artifact| artifact.path.as_path())
    }
}

impl OutputArtifacts {
    /// Returns the stripped runtime ELF path, when one has been prepared.
    pub fn elf(&self) -> Option<&Path> {
        self.runtime.elf.as_deref()
    }

    /// Returns the raw binary image path, when one has been prepared.
    pub fn bin(&self) -> Option<&Path> {
        self.runtime.bin.as_deref()
    }

    /// Returns the artifact directory that produced the runtime ELF.
    #[allow(dead_code)]
    pub fn cargo_artifact_dir(&self) -> Option<&Path> {
        self.cargo
            .as_ref()
            .map(|cargo| cargo.artifact_dir.as_path())
            .or(self.runtime.source_artifact_dir.as_deref())
    }

    /// Returns the Cargo source artifact directory, when the source came from Cargo.
    pub(crate) fn cargo_source_artifact_dir(&self) -> Option<&Path> {
        self.cargo
            .as_ref()
            .map(|cargo| cargo.artifact_dir.as_path())
    }

    /// Returns the directory containing the runtime artifacts consumed by runners.
    pub fn runtime_artifact_dir(&self) -> Option<&Path> {
        self.runtime.artifact_dir.as_deref()
    }

    /// Returns the preferred image path for runners that can load BIN or ELF.
    pub(crate) fn runtime_image(&self) -> Option<&Path> {
        self.bin().or_else(|| self.elf())
    }

    /// Returns the prepared BIN path or the caller-provided error message.
    pub(crate) fn require_bin(&self, message: &'static str) -> anyhow::Result<&Path> {
        self.bin().ok_or_else(|| anyhow!(message))
    }

    #[cfg(test)]
    pub(crate) fn set_runtime_artifact_dir(&mut self, path: PathBuf) {
        self.runtime.artifact_dir = Some(path);
    }

    /// Replaces artifact state from a prepared runtime artifact set.
    pub(crate) fn apply_prepared_runtime_artifacts(&mut self, prepared: &PreparedRuntimeArtifacts) {
        self.cargo = prepared
            .cargo_source_artifact_dir()
            .map(|artifact_dir| CargoArtifactState {
                elf: prepared.elf().to_path_buf(),
                artifact_dir: artifact_dir.to_path_buf(),
            });
        self.runtime.elf = Some(prepared.elf().to_path_buf());
        self.runtime.bin = prepared.bin().map(PathBuf::from);
        self.runtime.artifact_dir = prepared.runtime_artifact_dir().map(PathBuf::from);
        self.runtime.source_artifact_dir = prepared.cargo_artifact_dir().map(PathBuf::from);
    }

    #[allow(dead_code)]
    pub(crate) fn debug_artifacts(&self) -> &DebugArtifactRegistry {
        &self.debug
    }

    #[cfg(test)]
    pub(crate) fn register_debug_artifact(&mut self, kind: DebugArtifactKind, path: PathBuf) {
        self.debug.register(kind, path);
    }

    #[cfg(test)]
    pub(crate) fn cargo_source_elf(&self) -> Option<&Path> {
        self.cargo.as_ref().map(|cargo| cargo.elf.as_path())
    }
}

#[cfg(test)]
mod tests {
    use std::path::{Path, PathBuf};

    use super::{DebugArtifactKind, OutputArtifacts};

    #[test]
    fn debug_artifacts_do_not_change_runtime_image() {
        let mut artifacts = OutputArtifacts::default();
        artifacts.register_debug_artifact(
            DebugArtifactKind::Disassembly,
            PathBuf::from("/tmp/kernel.disassembly"),
        );

        assert!(artifacts.elf().is_none());
        assert!(artifacts.bin().is_none());
        assert!(artifacts.runtime_image().is_none());
        assert_eq!(
            artifacts
                .debug_artifacts()
                .get(DebugArtifactKind::Disassembly),
            Some(Path::new("/tmp/kernel.disassembly"))
        );
    }
}