Rust for Systems Programming: Linux Kernel Modules

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default nightly

# Install kernel sources
git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
cd linux

# Check Rust support
grep CONFIG_RUST .config
# CONFIG_RUST=y  (or =m for modules)

# Rust compiler for kernel
rustc --version  # Must be nightly

# Additional tools
rustup component add rust-src
cargo install bindgen

# Kernel build tools
sudo apt install build-essential linux-headers-$(uname -r)

// hello.rs
#![no_std]
#![feature(never_type)]

use kernel::prelude::*;

module! {
    type: HelloWorld,
    name: "hello_world",
    author: "Your Name",
    license: "GPL",
    description: "A simple Hello World kernel module",
}

struct HelloWorld;

impl kernel::module::Module for HelloWorld {
    fn init(_name: &'static CStr, _module: &'static ThisModule) -> Result<Self> {
        println!("Hello from Rust kernel module!");
        Ok(HelloWorld)
    }
}

impl Drop for HelloWorld {
    fn drop(&mut self) {
        println!("Goodbye from Rust kernel module!");
    }
}

# Add to Kconfig
config HELLO_RUST
    tristate "Hello World Rust Module"
    help
        A simple hello world module written in Rust

# Add to Makefile
obj-$(CONFIG_HELLO_RUST) += hello.o
hello-y := hello.rs

# Build
make modules LLVM=1
insmod hello.ko

# Check loaded modules
lsmod | grep hello_world
# hello_world            16384  0

# Check kernel messages
dmesg
# [12345.678901] Hello from Rust kernel module!

# Unload
rmmod hello_world
# [12345.789012] Goodbye from Rust kernel module!

use kernel::prelude::*;
use kernel::file_operations::FileOperations;
use kernel::miscdev::MiscDevice;

module! {
    type: CharDevice,
    name: "rust_char_dev",
    author: "Your Name",
    license: "GPL",
    description: "Character device driver in Rust",
}

struct CharDeviceOps;

impl FileOperations for CharDeviceOps {
    type Data = ();
    type OpenData = ();

    fn open(_context: &(), _file: &kernel::file::File) -> Result<()> {
        println!("Device opened");
        Ok(())
    }

    fn release(_context: &()) {
        println!("Device closed");
    }
}

struct CharDevice {
    _miscdev: MiscDevice,
}

impl kernel::module::Module for CharDevice {
    fn init(_name: &'static CStr, _module: &'static ThisModule) -> Result<Self> {
        let miscdev = MiscDevice::new(
            CharDeviceOps,
            (),
            c_str!("rust_device"),
        )?;
        
        println!("Character device created");
        Ok(CharDevice { _miscdev: miscdev })
    }
}

impl Drop for CharDevice {
    fn drop(&mut self) {
        println!("Character device destroyed");
    }
}

use kernel::alloc::BoxExt;
use kernel::prelude::*;

pub fn allocate_example() -> Result<()> {
    // Allocate a boxed i32
    let boxed = Box::try_new(42)?;
    println!("Value: {}", *boxed);
    
    // Automatically freed when dropped
    Ok(())
}

pub fn allocate_vec() -> Result<()> {
    // Allocate vector
    let mut vec: Vec<i32> = Vec::new();
    vec.push(1)?;
    vec.push(2)?;
    vec.push(3)?;
    
    println!("Vector: {:?}", vec.len());
    Ok(())
}

use kernel::sync::{Arc, Mutex};
use kernel::prelude::*;

pub struct DeviceState {
    counter: u32,
    name: CString,
}

pub fn create_state() -> Result<()> {
    let state = Arc::try_new(Mutex::new(DeviceState {
        counter: 0,
        name: CString::try_from_fmt(fmt!("device"))?,
    }))?;

    {
        let mut guard = state.lock();
        guard.counter += 1;
        println!("Counter: {}", guard.counter);
    }

    Ok(())
}

use kernel::sync::Mutex;

pub fn mutex_example() -> Result<()> {
    let counter = Mutex::new(0);
    
    {
        let mut c = counter.lock();
        *c += 1;
    }
    
    println!("Count: {}", *counter.lock());
    Ok(())
}

use kernel::sync::SpinLock;

pub fn spinlock_example() -> Result<()> {
    let value = SpinLock::new(42);
    
    {
        let mut v = value.lock();
        *v = 100;
    }
    
    println!("Value: {}", *value.lock());
    Ok(())
}

use kernel::irq::{self, IrqHandler};
use kernel::prelude::*;

struct IrqData {
    count: u32,
}

impl IrqHandler for IrqData {
    type Data = ();

    fn handle_irq(_: &Self::Data) -> irq::IrqReturn {
        println!("Interrupt received");
        irq::IrqReturn::Handled
    }
}

pub fn register_handler() -> Result<()> {
    // Register IRQ handler
    // irq::request_irq(IRQ_NUM, &handler)?;
    Ok(())
}

use kernel::prelude::*;
use kernel::module;

pub fn exported_function(value: i32) -> i32 {
    value * 2
}

module_export!();

#[export_name = "rust_exported_function"]
pub fn exported(value: i32) -> i32 {
    exported_function(value)
}

#![no_std]

use kernel::prelude::*;
use kernel::file::{File, SeekFrom};
use kernel::file_operations::FileOperations;
use kernel::miscdev::MiscDevice;
use kernel::sync::Mutex;

module! {
    type: CounterDevice,
    name: "rust_counter",
    author: "Kernel Developer",
    license: "GPL",
    description: "A simple counter device in Rust",
}

struct CounterData {
    counter: Mutex<i32>,
}

struct CounterOps;

impl FileOperations for CounterOps {
    type Data = CounterData;
    type OpenData = ();

    fn open(_context: &(), _file: &File) -> Result<()> {
        pr_info!("Counter device opened\n");
        Ok(())
    }

    fn release(_context: &CounterData) {
        pr_info!("Counter device closed\n");
    }
}

struct CounterDevice {
    _miscdev: MiscDevice,
}

impl kernel::module::Module for CounterDevice {
    fn init(_name: &'static CStr, _module: &'static ThisModule) -> Result<Self> {
        let data = CounterData {
            counter: Mutex::new(0),
        };

        let miscdev = MiscDevice::new(
            CounterOps,
            data,
            c_str!("rust_counter"),
        )?;

        pr_info!("Counter module loaded\n");
        Ok(CounterDevice { _miscdev: miscdev })
    }
}

impl Drop for CounterDevice {
    fn drop(&mut self) {
        pr_info!("Counter module unloaded\n");
    }
}

use kernel::prelude::*;

// Different log levels
pr_info!("Information message\n");
pr_warn!("Warning message\n");
pr_err!("Error message\n");
pr_debug!("Debug message (if CONFIG_DEBUG enabled)\n");

// String formatting
let value = 42;
pr_info!("Value: {}\n", value);

# Build with debug info
make modules DEBUG=1

# Load module with GDB
gdb vmlinux
(gdb) target remote :1234  # Connect to QEMU
(gdb) add-symbol-file hello.ko 0xXXXX
(gdb) break hello_init
(gdb) continue