Un Binario Rust Autónomo

El primer paso para crear nuestro propio kernel de sistema operativo es crear un ejecutable en Rust que no enlace con la biblioteca estándar. Esto hace posible ejecutar código Rust directamente en el bare metal sin un sistema operativo subyacente.

Este blog se desarrolla abiertamente en GitHub. Si tienes algún problema o pregunta, por favor abre un issue allí. También puedes dejar comentarios al final. El código fuente completo para esta publicación se encuentra en la rama post-01.

🔗Introducción

Para escribir un kernel de sistema operativo, necesitamos código que no dependa de características del sistema operativo. Esto significa que no podemos usar hilos, archivos, memoria dinámica, redes, números aleatorios, salida estándar ni ninguna otra característica que requiera abstracciones de sistema operativo o hardware específico. Esto tiene sentido, ya que estamos intentando escribir nuestro propio sistema operativo y nuestros propios controladores.

Esto implica que no podemos usar la mayor parte de la biblioteca estándar de Rust, pero hay muchas características de Rust que sí podemos usar. Por ejemplo, podemos utilizar iteradores, closures, pattern matching, option y result, formateo de cadenas y, por supuesto, el sistema de ownership. Estas características hacen posible escribir un kernel de una manera muy expresiva y de alto nivel, sin preocuparnos por el comportamiento indefinido o la seguridad de la memoria.

Para crear un kernel de sistema operativo en Rust, necesitamos crear un ejecutable que pueda ejecutarse sin un sistema operativo subyacente. Dicho ejecutable se llama frecuentemente un ejecutable “autónomo” o de “bare metal”.

Esta publicación describe los pasos necesarios para crear un binario autónomo en Rust y explica por qué son necesarios. Si solo te interesa un ejemplo mínimo, puedes saltar al resumen.

🔗Deshabilitando la Biblioteca Estándar

Por defecto, todos los crates de Rust enlazan con la biblioteca estándar, que depende del sistema operativo para características como hilos, archivos o redes. También depende de la biblioteca estándar de C, libc, que interactúa estrechamente con los servicios del sistema operativo. Como nuestro plan es escribir un sistema operativo, no podemos usar ninguna biblioteca que dependa del sistema operativo. Por lo tanto, tenemos que deshabilitar la inclusión automática de la biblioteca estándar mediante el atributo no_std.

Comenzamos creando un nuevo proyecto de aplicación en Cargo. La forma más fácil de hacerlo es a través de la línea de comandos:

cargo new blog_os --bin --edition 2018

Nombré el proyecto blog_os, pero, por supuesto, puedes elegir tu propio nombre. La bandera --bin especifica que queremos crear un binario ejecutable (en contraste con una biblioteca), y la bandera --edition 2018 indica que queremos usar la [edición 2018] de Rust para nuestro crate. Al ejecutar el comando, Cargo crea la siguiente estructura de directorios para nosotros:

blog_os
├── Cargo.toml
└── src
    └── main.rs

El archivo Cargo.toml contiene la configuración del crate, como el nombre del crate, el autor, el número de [versión semántica] y las dependencias. El archivo src/main.rs contiene el módulo raíz de nuestro crate y nuestra función main. Puedes compilar tu crate utilizando cargo build y luego ejecutar el binario compilado blog_os ubicado en la subcarpeta target/debug.

🔗El Atributo no_std

Actualmente, nuestro crate enlaza implícitamente con la biblioteca estándar. Intentemos deshabilitar esto añadiendo el [atributo no_std]:

// main.rs

#![no_std]

fn main() {
    println!("Hello, world!");
}

Cuando intentamos compilarlo ahora (ejecutando cargo build), ocurre el siguiente error:

error: cannot find macro `println!` in this scope
 --> src/main.rs:4:5
  |
4 |     println!("Hello, world!");
  |     ^^^^^^^

La razón de este error es que la macro println forma parte de la biblioteca estándar, la cual ya no estamos incluyendo. Por lo tanto, ya no podemos imprimir cosas. Esto tiene sentido, ya que println escribe en la salida estándar, que es un descriptor de archivo especial proporcionado por el sistema operativo.

Así que eliminemos la impresión e intentemos de nuevo con una función main vacía:

// main.rs

#![no_std]

fn main() {}

> cargo build
error: `#[panic_handler]` function required, but not found
error: language item required, but not found: `eh_personality`

Ahora el compilador indica que falta una función #[panic_handler] y un elemento de lenguaje (language item).

🔗Implementación de Panic

El atributo panic_handler define la función que el compilador invoca cuando ocurre un panic. La biblioteca estándar proporciona su propia función de panico, pero en un entorno no_std debemos definirla nosotros mismos:

// en main.rs

use core::panic::PanicInfo;

/// Esta función se llama cuando ocurre un pánico.
#[panic_handler]
fn panic(_info: &PanicInfo) -> ! {
    loop {}
}

El parámetro PanicInfo contiene el archivo y la línea donde ocurrió el panic, así como el mensaje opcional del panic. La función no debería retornar nunca, por lo que se marca como una función divergente devolviendo el tipo “never” !. Por ahora, no hay mucho que podamos hacer en esta función, así que simplemente entramos en un bucle infinito.

🔗El Elemento de Lenguaje eh_personality

Los elementos de lenguaje son funciones y tipos especiales que el compilador requiere internamente. Por ejemplo, el trait Copy es un elemento de lenguaje que indica al compilador qué tipos tienen semántica de copia. Si observamos su implementación, veremos que tiene el atributo especial #[lang = "copy"], que lo define como un elemento de lenguaje.

Aunque es posible proporcionar implementaciones personalizadas de elementos de lenguaje, esto debería hacerse solo como último recurso. La razón es que los elementos de lenguaje son detalles de implementación altamente inestables y ni siquiera están verificados por tipos (el compilador no comprueba si una función tiene los tipos de argumento correctos). Afortunadamente, hay una forma más estable de solucionar el error relacionado con el elemento de lenguaje mencionado.

El elemento de lenguaje eh_personality marca una función utilizada para implementar el desenrollado de pila. Por defecto, Rust utiliza unwinding para ejecutar los destructores de todas las variables de pila activas en caso de un pánico. Esto asegura que toda la memoria utilizada sea liberada y permite que el hilo principal capture el pánico y continúe ejecutándose. Sin embargo, el unwinding es un proceso complicado y requiere algunas bibliotecas específicas del sistema operativo (por ejemplo, libunwind en Linux o manejadores estructurados de excepciones en Windows), por lo que no queremos usarlo en nuestro sistema operativo.

🔗Deshabilitando el Unwinding

Existen otros casos de uso en los que el no es deseable, por lo que Rust proporciona una opción para abortar en caso de pánico. Esto desactiva la generación de información de símbolos de unwinding y, por lo tanto, reduce considerablemente el tamaño del binario. Hay múltiples lugares donde podemos deshabilitar el unwinding. La forma más sencilla es agregar las siguientes líneas a nuestro archivo Cargo.toml:

[profile.dev]
panic = "abort"

[profile.release]
panic = "abort"

Esto establece la estrategia de pánico en abort tanto para el perfil dev (utilizado en cargo build) como para el perfil release (utilizado en cargo build --release). Ahora, el elemento de lenguaje eh_personality ya no debería ser necesario.

Ahora hemos solucionado ambos errores anteriores. Sin embargo, si intentamos compilarlo ahora, ocurre otro error:

> cargo build
error: requires `start` lang_item

Nuestro programa carece del elemento de lenguaje start, que define el punto de entrada.

🔗El Atributo start

Podría pensarse que la función main es la primera que se ejecuta al correr un programa. Sin embargo, la mayoría de los lenguajes tienen un sistema de tiempo de ejecución, encargado de tareas como la recolección de basura (por ejemplo, en Java) o los hilos de software (por ejemplo, goroutines en Go). Este sistema de tiempo de ejecución necesita ejecutarse antes de main, ya que debe inicializarse.

En un binario típico de Rust que enlaza con la biblioteca estándar, la ejecución comienza en una biblioteca de tiempo de ejecución de C llamada crt0 (“C runtime zero”), que configura el entorno para una aplicación en C. Esto incluye la creación de una pila y la colocación de los argumentos en los registros adecuados. Luego, el tiempo de ejecución de C invoca el punto de entrada del tiempo de ejecución de Rust, que está marcado por el elemento de lenguaje start. Rust tiene un tiempo de ejecución muy minimalista, que se encarga de tareas menores como configurar los guardias de desbordamiento de pila o imprimir un backtrace en caso de pánico. Finalmente, el tiempo de ejecución llama a la función main.

Nuestro ejecutable autónomo no tiene acceso al tiempo de ejecución de Rust ni a crt0, por lo que necesitamos definir nuestro propio punto de entrada. Implementar el elemento de lenguaje start no ayudaría, ya que aún requeriría crt0. En su lugar, debemos sobrescribir directamente el punto de entrada de crt0.

🔗Sobrescribiendo el Punto de Entrada

Para indicar al compilador de Rust que no queremos usar la cadena normal de puntos de entrada, agregamos el atributo #![no_main]:

#![no_std]
#![no_main]

use core::panic::PanicInfo;

/// Esta función se llama cuando ocurre un pánico.
#[panic_handler]
fn panic(_info: &PanicInfo) -> ! {
    loop {}
}

Podrás notar que eliminamos la función main. La razón es que una función main no tiene sentido sin un sistema de tiempo de ejecución subyacente que la invoque. En su lugar, estamos sobrescribiendo el punto de entrada del sistema operativo con nuestra propia función _start:

#[no_mangle]
pub extern "C" fn _start() -> ! {
    loop {}
}

Al usar el atributo #[no_mangle], deshabilitamos el name mangling para asegurarnos de que el compilador de Rust realmente genere una función con el nombre _start. Sin este atributo, el compilador generaría un símbolo críptico como _ZN3blog_os4_start7hb173fedf945531caE para dar un nombre único a cada función. Este atributo es necesario porque necesitamos informar al enlazador el nombre de la función de punto de entrada en el siguiente paso.

También debemos marcar la función como extern "C" para indicar al compilador que debe usar la convención de llamadas en C para esta función (en lugar de la convención de llamadas de Rust, que no está especificada). El motivo para nombrar la función _start es que este es el nombre predeterminado del punto de entrada en la mayoría de los sistemas.

El tipo de retorno ! significa que la función es divergente, es decir, no está permitido que retorne nunca. Esto es necesario porque el punto de entrada no es llamado por ninguna función, sino que es invocado directamente por el sistema operativo o el bootloader. En lugar de retornar, el punto de entrada debería, por ejemplo, invocar la llamada al sistema exit del sistema operativo. En nuestro caso, apagar la máquina podría ser una acción razonable, ya que no queda nada por hacer si un binario autónomo regresa. Por ahora, cumplimos con este requisito entrando en un bucle infinito.

Cuando ejecutamos cargo build ahora, obtenemos un feo error del linker (enlazador).

🔗Errores del Enlazador

El enlazador es un programa que combina el código generado en un ejecutable. Dado que el formato del ejecutable varía entre Linux, Windows y macOS, cada sistema tiene su propio enlazador que lanza errores diferentes. Sin embargo, la causa fundamental de los errores es la misma: la configuración predeterminada del enlazador asume que nuestro programa depende del tiempo de ejecución de C, lo cual no es cierto.

Para solucionar los errores, necesitamos informar al enlazador que no debe incluir el tiempo de ejecución de C. Esto puede hacerse pasando un conjunto específico de argumentos al enlazador o construyendo para un destino de bare metal.

🔗Construyendo para un Destino de Bare Metal

Por defecto, Rust intenta construir un ejecutable que pueda ejecutarse en el entorno actual de tu sistema. Por ejemplo, si estás usando Windows en x86_64, Rust intenta construir un ejecutable .exe para Windows que utilice instrucciones x86_64. Este entorno se llama tu sistema “host”.

Para describir diferentes entornos, Rust utiliza una cadena llamada [target triple]. Puedes ver el target triple de tu sistema host ejecutando:

rustc 1.35.0-nightly (474e7a648 2019-04-07)
binary: rustc
commit-hash: 474e7a6486758ea6fc761893b1a49cd9076fb0ab
commit-date: 2019-04-07
host: x86_64-unknown-linux-gnu
release: 1.35.0-nightly
LLVM version: 8.0

El resultado anterior es de un sistema Linux x86_64. Vemos que la tripleta del host es x86_64-unknown-linux-gnu, lo que incluye la arquitectura de la CPU (x86_64), el proveedor (unknown), el sistema operativo (linux) y el ABI (gnu).

Al compilar para la tripleta del host, el compilador de Rust y el enlazador asumen que hay un sistema operativo subyacente como Linux o Windows que utiliza el tiempo de ejecución de C de forma predeterminada, lo que provoca los errores del enlazador. Para evitar estos errores, podemos compilar para un entorno diferente que no tenga un sistema operativo subyacente.

Un ejemplo de este tipo de entorno bare metal es la tripleta de destino thumbv7em-none-eabihf, que describe un sistema [embebido][embedded] basado en [ARM]. Los detalles no son importantes, lo que importa es que la tripleta de destino no tiene un sistema operativo subyacente, lo cual se indica por el none en la tripleta de destino. Para poder compilar para este destino, necesitamos agregarlo usando rustup:

rustup target add thumbv7em-none-eabihf

Esto descarga una copia de las bibliotecas estándar (y core) para el sistema. Ahora podemos compilar nuestro ejecutable autónomo para este destino:

cargo build --target thumbv7em-none-eabihf

Al pasar un argumento --target, realizamos un compilado cruzado de nuestro ejecutable para un sistema bare metal. Dado que el sistema de destino no tiene un sistema operativo, el enlazador no intenta enlazar con el tiempo de ejecución de C, y nuestra compilación se completa sin errores del enlazador.

Este es el enfoque que utilizaremos para construir nuestro kernel de sistema operativo. En lugar de thumbv7em-none-eabihf, utilizaremos un destino personalizado que describa un entorno bare metal x86_64. Los detalles se explicarán en la siguiente publicación.

🔗Argumentos del Enlazador

En lugar de compilar para un sistema bare metal, también es posible resolver los errores del enlazador pasando un conjunto específico de argumentos al enlazador. Este no es el enfoque que usaremos para nuestro kernel, por lo tanto, esta sección es opcional y se proporciona solo para completar. Haz clic en “Argumentos del Enlazador” a continuación para mostrar el contenido opcional.

error: linking with `cc` failed: exit code: 1
  |
  = note: "cc" […]
  = note: /usr/lib/gcc/../x86_64-linux-gnu/Scrt1.o: In function `_start':
          (.text+0x12): undefined reference to `__libc_csu_fini'
          /usr/lib/gcc/../x86_64-linux-gnu/Scrt1.o: In function `_start':
          (.text+0x19): undefined reference to `__libc_csu_init'
          /usr/lib/gcc/../x86_64-linux-gnu/Scrt1.o: In function `_start':
          (.text+0x25): undefined reference to `__libc_start_main'
          collect2: error: ld returned 1 exit status

cargo rustc -- -C link-arg=-nostartfiles

error: linking with `link.exe` failed: exit code: 1561
  |
  = note: "C:\\Program Files (x86)\\…\\link.exe" […]
  = note: LINK : fatal error LNK1561: entry point must be defined

cargo rustc -- -C link-arg=/ENTRY:_start

error: linking with `link.exe` failed: exit code: 1221
  |
  = note: "C:\\Program Files (x86)\\…\\link.exe" […]
  = note: LINK : fatal error LNK1221: a subsystem can't be inferred and must be
          defined

cargo rustc -- -C link-args="/ENTRY:_start /SUBSYSTEM:console"

error: linking with `cc` failed: exit code: 1
  |
  = note: "cc" […]
  = note: ld: entry point (_main) undefined. for architecture x86_64
          clang: error: linker command failed with exit code 1 […]

cargo rustc -- -C link-args="-e __start"

error: linking with `cc` failed: exit code: 1
  |
  = note: "cc" […]
  = note: ld: dynamic main executables must link with libSystem.dylib
          for architecture x86_64
          clang: error: linker command failed with exit code 1 […]

cargo rustc -- -C link-args="-e __start -static"

error: linking with `cc` failed: exit code: 1
  |
  = note: "cc" […]
  = note: ld: library not found for -lcrt0.o
          clang: error: linker command failed with exit code 1 […]

cargo rustc -- -C link-args="-e __start -static -nostartfiles"

# en .cargo/config.toml

[target.'cfg(target_os = "linux")']
rustflags = ["-C", "link-arg=-nostartfiles"]

[target.'cfg(target_os = "windows")']
rustflags = ["-C", "link-args=/ENTRY:_start /SUBSYSTEM:console"]

[target.'cfg(target_os = "macos")']
rustflags = ["-C", "link-args=-e __start -static -nostartfiles"]

🔗Resumen

Un binario mínimo autónomo en Rust se ve así:

src/main.rs:

#![no_std] // no enlazar con la biblioteca estándar de Rust
#![no_main] // deshabilitar todos los puntos de entrada a nivel de Rust

use core::panic::PanicInfo;

#[no_mangle] // no modificar el nombre de esta función
pub extern "C" fn _start() -> ! {
    // esta función es el punto de entrada, ya que el enlazador busca una función
    // llamada `_start` por defecto
    loop {}
}

/// Esta función se llama cuando ocurre un pánico.
#[panic_handler]
fn panic(_info: &PanicInfo) -> ! {
    loop {}
}

Cargo.toml:

[package]
name = "crate_name"
version = "0.1.0"
authors = ["Author Name <author@example.com>"]

# el perfil usado para `cargo build`
[profile.dev]
panic = "abort" # deshabilitar el desenrollado de la pila en caso de pánico

# el perfil usado para `cargo build --release`
[profile.release]
panic = "abort" # deshabilitar el desenrollado de la pila en caso de pánico

Para construir este binario, necesitamos compilar para un destino bare metal, como thumbv7em-none-eabihf:

cargo build --target thumbv7em-none-eabihf

Alternativamente, podemos compilarlo para el sistema host pasando argumentos adicionales al enlazador:

# Linux
cargo rustc -- -C link-arg=-nostartfiles
# Windows
cargo rustc -- -C link-args="/ENTRY:_start /SUBSYSTEM:console"
# macOS
cargo rustc -- -C link-args="-e __start -static -nostartfiles"

Ten en cuenta que este es solo un ejemplo mínimo de un binario autónomo en Rust. Este binario espera varias cosas, por ejemplo, que una pila esté inicializada cuando se llama a la función _start. Por lo tanto, para cualquier uso real de un binario como este, se requieren más pasos.

🔗¿Qué sigue?

La próxima publicación explica los pasos necesarios para convertir nuestro binario autónomo en un kernel de sistema operativo mínimo. Esto incluye crear un destino personalizado, combinar nuestro ejecutable con un bootloader y aprender cómo imprimir algo en la pantalla.