tawasuyu

tawasuyu/brahman

Rust 582TOML 222Markdown 73JSON 198629 Definiciones

⎇ 922ad1f86bbef5d4f8c5f59827e5fd6a9b17c1af renaser/boot/src/main.rs Rust · 345 líneas · 15.5 KB Historia Quién tocó qué crudo

feat(renaser): Fase 12 — la bocina del PC como capacidad de host 922ad1f86 · sergio ·

1// =============================================================================
2//  renaser :: boot/src/main.rs — Fase 1.5 :: el puente hacia el silicio
3// -----------------------------------------------------------------------------
4//  Un kernel bare-metal no nace solo: alguien debe fusionarlo con un cargador,
5//  sellarlo en una imagen de disco arrancable y entregarlo al hardware. Esa es
6//  la mision de este orquestador de ANFITRION.
7//
8//  Desde la Fase 7b hace algo mas: SIEMBRA el grafo. El kernel ya no empotra
9//  el userspace —ni un solo `include_bytes!` de un `.wasm`—; en su lugar, este
10//  constructor pre-puebla el disco de objetos con el bytecode de las apps de
11//  genesis y el Manifiesto de Genesis que dicta cuales arrancan, en que region
12//  y con que cuota. Para ello habla el MISMO formato del grafo que el kernel,
13//  a traves de la crate compartida `formato`.
14//
15//  El flujo es deliberadamente lineal y sin ambiguedad:
16//
17//    1. Localizar el ELF nativo del kernel (lo inyecta la dep. de artefacto).
18//    2. Fusionarlo con el cargador UEFI en una imagen de disco GPT.
19//    3. Sembrar el disco de objetos: el grafo poblado con el bytecode del
20//       userspace y el Manifiesto de Genesis (Fase 7b).
21//    4. Lanzar QEMU con la imagen, el disco de objetos y el firmware OVMF.
22//
23//  Cada paso que pueda fallar lo hace en voz alta, con un mensaje accionable:
24//  preferimos un error claro a un arranque silencioso hacia la nada.
25// =============================================================================
26
27use std::collections::BTreeMap;
28use std::io::Write;
29use std::path::{Path, PathBuf};
30use std::process::Command;
31
32// El formato del grafo de objetos en disco — el MISMO nucleo `no_std` que
33// enlaza el kernel. Gracias a el, lo que `boot` siembra y lo que el kernel lee
34// es, byte a byte, el mismo idioma.
35use formato::{
36    EntradaApp, Hash, Manifiesto, Objeto, SuperBloque, MAGIA, MAX_OBJETO, TAM_SECTOR,
37    VERSION_MANIFIESTO, VERSION_SUPERBLOQUE,
38};
39
40/// Ruta del ELF del kernel, ya compilado para `x86_64-unknown-none`.
41///
42/// La dependencia de artefacto define esta variable de entorno en tiempo de
43/// compilacion: cuando este binario de anfitrion existe, el kernel ya existe.
44const KERNEL_ELF: &str = env!("CARGO_BIN_FILE_KERNEL_kernel");
45
46/// Firmware UEFI OVMF tal como lo empaqueta Artix Linux (paquete `edk2-ovmf`).
47/// Es la imagen combinada codigo+variables, apta para `-bios`.
48const OVMF_POR_DEFECTO: &str = "/usr/share/edk2/x64/OVMF.4m.fd";
49
50/// Nombre de la imagen de disco UEFI que renaser genera.
51const NOMBRE_IMAGEN: &str = "renaser-uefi.img";
52
53/// Ruta del disco de objetos del grafo persistente (Fase 6.1c). Relativa al
54/// directorio de trabajo —la raiz del repo—, comun a `boot` y a QEMU.
55const NOMBRE_DISCO: &str = "target/disk.img";
56
57/// Tamaño del disco de objetos: 32 MiB. La imagen sembrada ocupa solo unos
58/// pocos KiB; el resto queda a cero —espacio libre para que el grafo crezca—.
59const TAM_DISCO: u64 = 32 * 1024 * 1024;
60
61fn main() {
62    if let Err(fallo) = orquestar() {
63        // Un error de orquestacion se anuncia en rojo y aborta con codigo 1:
64        // ninguna falla del anfitrion debe disfrazarse de exito.
65        eprintln!("\x1b[1;31m[renaser/boot] fallo:\x1b[0m {fallo}");
66        std::process::exit(1);
67    }
68}
69
70/// Ejecuta, en orden, las operaciones de la Fase 1.5.
71fn orquestar() -> Result<(), String> {
72    // --- 1. Localizar el artefacto del kernel. ---
73    let kernel = Path::new(KERNEL_ELF);
74    if !kernel.is_file() {
75        return Err(format!(
76            "no se encontro el ELF del kernel en {}\n  \
77             (¿se interrumpio la compilacion de la dependencia de artefacto?)",
78            kernel.display()
79        ));
80    }
81    println!("[renaser/boot] kernel localizado :: {}", kernel.display());
82
83    // --- 2. Fusionar kernel + cargador UEFI en una imagen de disco. ---
84    let imagen = ruta_imagen(kernel);
85    println!("[renaser/boot] forjando imagen UEFI :: {}", imagen.display());
86    bootloader::UefiBoot::new(kernel)
87        .create_disk_image(&imagen)
88        .map_err(|e| format!("la crate `bootloader` no pudo crear la imagen UEFI: {e:?}"))?;
89
90    // --- 3. Garantizar —y, si es virgen, SEMBRAR— el disco de objetos. ---
91    preparar_disco_objetos()?;
92
93    // --- 4. Lanzar QEMU sobre esa imagen. ---
94    let ovmf = localizar_ovmf()?;
95    lanzar_qemu(&imagen, &ovmf)
96}
97
98// =============================================================================
99//  Fase 7b — la siembra del grafo: el userspace nace de la imagen de disco
100// =============================================================================
101
102/// Una app de genesis: su nombre legible, el `.wasm` que la encarna y la
103/// ventana del framebuffer que habitara — `(x, y, ancho, alto)` en pixeles.
104struct AppGenesis {
105    nombre: &'static str,
106    archivo: &'static str,
107    region: (u32, u32, u32, u32),
108}
109
110/// El userspace de genesis — las siete aplicaciones que pueblan un disco recien
111/// forjado. La melodia visual `tonada` (Fase 12), el compas visual `pulso`
112/// (Fase 11), un saludo (`hola`), la `memoriosa` interactiva que recuerda entre
113/// sesiones (Fase 7c), y tres demos de los guardarrailes del kernel: `discola`
114/// (combustible), `glotona` (memoria) y `cronista` (la cronica de los arranques).
115const GENESIS: [AppGenesis; 7] = [
116    AppGenesis { nombre: "tonada", archivo: "tonada.wasm", region: (100, 120, 360, 120) },
117    AppGenesis { nombre: "pulso", archivo: "pulso.wasm", region: (100, 120, 360, 120) },
118    AppGenesis { nombre: "hola", archivo: "app.wasm", region: (100, 120, 480, 560) },
119    AppGenesis { nombre: "memoriosa", archivo: "memoriosa.wasm", region: (700, 120, 360, 80) },
120    AppGenesis { nombre: "discola", archivo: "discola.wasm", region: (60, 700, 360, 80) },
121    AppGenesis { nombre: "glotona", archivo: "glotona.wasm", region: (460, 700, 360, 80) },
122    AppGenesis { nombre: "cronista", archivo: "cronista.wasm", region: (860, 700, 360, 80) },
123];
124
125/// Techo de memoria lineal de cada app de genesis: 4 MiB. Un modulo que intente
126/// crecer su memoria mas alla es desalojado por el kernel.
127const TECHO_GENESIS: u32 = 4 * 1024 * 1024;
128
129/// Garantiza la existencia del disco de objetos del grafo persistente. Si ya
130/// existe, lo RESPETA — el grafo perdura entre arranques (la cuenta de la
131/// cronista, el estado del userspace). Si no existe, lo forja Y LO SIEMBRA:
132/// graba el grafo ya poblado con el bytecode de las apps y su Manifiesto de
133/// Genesis. El kernel jamas vuelve a empotrar una sola app.
134fn preparar_disco_objetos() -> Result<(), String> {
135    let disco = Path::new(NOMBRE_DISCO);
136    if disco.is_file() {
137        println!(
138            "[renaser/boot] disco de objetos presente :: {} — el grafo perdura",
139            disco.display()
140        );
141        return Ok(());
142    }
143    if let Some(directorio) = disco.parent() {
144        std::fs::create_dir_all(directorio)
145            .map_err(|e| format!("no se pudo crear el directorio del disco de objetos: {e}"))?;
146    }
147
148    // Sembrar el grafo: el bytecode del userspace y el Manifiesto de Genesis.
149    let (imagen, objetos) = sembrar_grafo()?;
150    if imagen.len() as u64 > TAM_DISCO {
151        return Err(format!(
152            "el grafo sembrado ({} bytes) no cabe en el disco de objetos ({TAM_DISCO} bytes)",
153            imagen.len()
154        ));
155    }
156
157    // Escribir la imagen sembrada y extender el fichero a 32 MiB: el log queda
158    // al principio; el resto, a cero —`set_len` lo deja disperso—.
159    let mut fichero = std::fs::File::create(disco)
160        .map_err(|e| format!("no se pudo crear el disco de objetos «{}»: {e}", disco.display()))?;
161    fichero
162        .write_all(&imagen)
163        .map_err(|e| format!("no se pudo escribir el grafo sembrado: {e}"))?;
164    fichero
165        .set_len(TAM_DISCO)
166        .map_err(|e| format!("no se pudo dimensionar el disco de objetos: {e}"))?;
167    println!(
168        "[renaser/boot] disco de objetos sembrado :: {} ({objetos} objetos, manifiesto anclado)",
169        disco.display()
170    );
171    Ok(())
172}
173
174/// Lee el bytecode `.wasm` de una app de genesis desde `kernel/assets/`. La
175/// ruta se ancla al directorio de ESTE crate —no al de trabajo—: el
176/// constructor funciona se invoque desde donde se invoque.
177fn leer_wasm(archivo: &str) -> Result<Vec<u8>, String> {
178    let ruta = Path::new(env!("CARGO_MANIFEST_DIR"))
179        .join("../kernel/assets")
180        .join(archivo);
181    std::fs::read(&ruta)
182        .map_err(|e| format!("no se pudo leer el bytecode «{}»: {e}", ruta.display()))
183}
184
185/// Anexa un objeto al log: compone su registro `[longitud][payload][relleno]`,
186/// lo añade a la imagen y avanza el cursor. Devuelve el hash del objeto — su
187/// identidad en el grafo direccionado por contenido.
188fn anexar_objeto(log: &mut Vec<u8>, cursor: &mut u64, payload: &[u8]) -> Result<Hash, String> {
189    if payload.is_empty() || payload.len() > MAX_OBJETO {
190        return Err(format!(
191            "un objeto del grafo tiene un tamaño invalido: {} bytes",
192            payload.len()
193        ));
194    }
195    let hash = formato::hash(payload);
196    log.extend_from_slice(&formato::componer_registro(payload));
197    *cursor += formato::sectores_registro(payload.len());
198    Ok(hash)
199}
200
201/// Siembra el grafo de objetos de un disco virgen: graba el bytecode de cada
202/// app de genesis como un objeto del grafo, compone el Manifiesto de Genesis
203/// —con sus regiones y cuotas—, lo graba con las aristas hacia los objetos de
204/// bytecode, y forja el superbloque que lo ancla. Devuelve la imagen del disco
205/// (superbloque en el sector 0 + el log de registros) y el numero de objetos
206/// sembrados. Habla, byte a byte, el formato que el kernel leera al montar.
207fn sembrar_grafo() -> Result<(Vec<u8>, usize), String> {
208    // El log de registros: del sector 1 en adelante. El sector 0 es el
209    // superbloque, que aun no podemos escribir —no conocemos el cursor final—.
210    let mut log: Vec<u8> = Vec::new();
211    let mut cursor: u64 = 1;
212
213    // --- 1. Los objetos de bytecode, DEDUPLICADOS por archivo. Dos apps que
214    //        comparten el mismo `.wasm` comparten un unico objeto del grafo. ---
215    let mut hash_de: BTreeMap<&str, Hash> = BTreeMap::new();
216    let mut hijos_manifiesto: Vec<Hash> = Vec::new();
217    let mut apps: Vec<EntradaApp> = Vec::new();
218
219    for app in &GENESIS {
220        let bytecode = match hash_de.get(app.archivo) {
221            // Ya grabado: el grafo no guarda dos veces el mismo contenido.
222            Some(&hash) => hash,
223            None => {
224                let datos = leer_wasm(app.archivo)?;
225                let objeto = Objeto { datos, hijos: Vec::new() };
226                let payload = objeto.serializar().map_err(|e| e.to_string())?;
227                let hash = anexar_objeto(&mut log, &mut cursor, &payload)?;
228                hash_de.insert(app.archivo, hash);
229                hijos_manifiesto.push(hash);
230                hash
231            }
232        };
233        let (x, y, ancho, alto) = app.region;
234        apps.push(EntradaApp {
235            nombre: app.nombre.to_string(),
236            bytecode,
237            region_x: x,
238            region_y: y,
239            region_ancho: ancho,
240            region_alto: alto,
241            techo_memoria: TECHO_GENESIS,
242            estado: None,
243        });
244    }
245
246    // --- 2. El objeto del Manifiesto de Genesis. Sus `hijos` son los objetos
247    //        de bytecode: el grafo lo lee como el nodo padre del userspace. ---
248    let manifiesto = Manifiesto { version: VERSION_MANIFIESTO, apps };
249    let man_datos = manifiesto.serializar().map_err(|e| e.to_string())?;
250    let man_objeto = Objeto { datos: man_datos, hijos: hijos_manifiesto };
251    let man_payload = man_objeto.serializar().map_err(|e| e.to_string())?;
252    let hash_manifiesto = anexar_objeto(&mut log, &mut cursor, &man_payload)?;
253
254    // El grafo sembrado: un objeto por cada `.wasm` unico, mas el manifiesto.
255    let objetos = hash_de.len() + 1;
256
257    // --- 3. El superbloque: el ancla del grafo, en el sector 0. `raiz` queda
258    //        vacia —el userspace la fija; `manifiesto` apunta a la genesis. ---
259    let superbloque = SuperBloque {
260        magia: MAGIA,
261        version: VERSION_SUPERBLOQUE,
262        cursor,
263        raiz: None,
264        manifiesto: Some(hash_manifiesto),
265    };
266    let sb_bytes = superbloque.serializar().map_err(|e| e.to_string())?;
267    if sb_bytes.len() > TAM_SECTOR {
268        return Err("el superbloque sembrado no cabe en un sector".to_string());
269    }
270
271    // La imagen: el superbloque en el sector 0 (relleno a cero) y, tras el, el
272    // log de registros que acabamos de componer.
273    let mut imagen = vec![0u8; TAM_SECTOR];
274    imagen[..sb_bytes.len()].copy_from_slice(&sb_bytes);
275    imagen.extend_from_slice(&log);
276
277    Ok((imagen, objetos))
278}
279
280/// Calcula la ruta de la imagen: junto al propio ELF del kernel, es decir,
281/// dentro de `target/`. Una ubicacion predecible y siempre escribible.
282fn ruta_imagen(kernel: &Path) -> PathBuf {
283    kernel
284        .parent()
285        .unwrap_or_else(|| Path::new("."))
286        .join(NOMBRE_IMAGEN)
287}
288
289/// Resuelve la ruta del firmware OVMF. Permite sobreescribirla con la variable
290/// de entorno `RENASER_OVMF` para entornos cuyo `edk2-ovmf` viva en otra ruta.
291fn localizar_ovmf() -> Result<String, String> {
292    let ruta = std::env::var("RENASER_OVMF").unwrap_or_else(|_| OVMF_POR_DEFECTO.to_string());
293    if Path::new(&ruta).is_file() {
294        Ok(ruta)
295    } else {
296        Err(format!(
297            "firmware UEFI OVMF no encontrado en «{ruta}»\n  \
298             instala el paquete `edk2-ovmf`, o exporta RENASER_OVMF=<ruta a OVMF.fd>"
299        ))
300    }
301}
302
303/// Invoca QEMU como subproceso. Los argumentos se ciñen a las primitivas
304/// minimas necesarias para que el Framebuffer GOP cobre vida:
305///
306///   * `-bios`            firmware UEFI OVMF.
307///   * `-drive raw`       la imagen de disco UEFI, sin capa de traduccion.
308///   * `-vga std`         VGA estandar => framebuffer lineal que el GOP expone.
309///   * `-serial stdio`    telemetria serial del procesador hacia esta consola.
310///   * `--no-reboot`      un fallo triple detiene la maquina en vez de reiniciar
311///                        en bucle: asi la baliza de panico permanece visible.
312///   * `virtio-blk-pci`   el disco de objetos, sobre el bus PCI (q35 es x86_64;
313///                        `virtio-blk-device`, su gemelo MMIO, es cosa de ARM).
314fn lanzar_qemu(imagen: &Path, ovmf: &str) -> Result<(), String> {
315    println!("[renaser/boot] arrancando QEMU :: la superficie indigo nace ahora\n");
316
317    let mut qemu = Command::new("qemu-system-x86_64");
318    // `accel=kvm:tcg` intenta KVM y, si no esta disponible, recae en TCG puro.
319    qemu.arg("-machine").arg("q35,accel=kvm:tcg")
320        .arg("-m").arg("256M")
321        .arg("-bios").arg(ovmf)
322        .arg("-drive").arg(format!("format=raw,file={}", imagen.display()))
323        .arg("-vga").arg("std")
324        .arg("-serial").arg("stdio")
325        .arg("--no-reboot")
326        // El disco de objetos, como dispositivo virtio-blk sobre el bus PCI.
327        .arg("-drive").arg(format!("format=raw,file={NOMBRE_DISCO},if=none,id=drv0"))
328        .arg("-device").arg("virtio-blk-pci,drive=drv0");
329
330    // Cualquier argumento extra tras `--` se reenvia a QEMU intacto.
331    // Ejemplo: `cargo run -p boot -- -display none -d int`.
332    qemu.args(std::env::args().skip(1));
333
334    match qemu.status() {
335        Ok(estado) if estado.success() => {
336            println!("\n[renaser/boot] QEMU finalizo limpiamente.");
337            Ok(())
338        }
339        Ok(estado) => Err(format!("QEMU termino con estado anomalo: {estado}")),
340        Err(e) if e.kind() == std::io::ErrorKind::NotFound => Err(
341            "`qemu-system-x86_64` no esta en el PATH; instala el paquete `qemu-full`".to_string(),
342        ),
343        Err(e) => Err(format!("no se pudo ejecutar QEMU: {e}")),
344    }
345}