rust/kernel/lib.rs 是 Linux 内核 Rust 支持的核心入口文件(Crate Root),它定义了内核态 Rust 代码的标准库(kernel crate),封装了约 90 个子系统模块,为驱动开发和内核功能扩展提供内存安全的基础 API 。
1. 核心架构与模块分布
该文件通过 mod 声明将底层 C 内核功能抽象为 Rust模块,主要涵盖以下核心领域:
| 模块类别 | 核心文件/路径 | 关键功能与类型 |
|---|---|---|
| 内存管理 | alloc, mm, page |
分配器 trait (Allocator)、智能指针 (Box, Vec, Arc)、页抽象 (Page) |
| 并发同步 | sync |
互斥锁 (Mutex)、自旋锁 (SpinLock)、条件变量 (CondVar)、引用计数 (ARef) |
| 设备模型 | device, driver |
类型状态设备结构 (Device<Ctx>)、驱动注册框架 (Driver trait) |
| 总线子系统 | pci, usb, i2c, platform |
特定总线设备抽象与驱动 Trait (如 i2c::Driver, pci::Device) |
| 基础类型 | types, error, ffi |
不透明封装 (Opaque)、错误处理 (Error, Result)、FFI 类型定义 |
| 其他子系统 | fs, net, module |
文件系统操作 (FileOps)、网络栈 (Netlink, PHY)、模块宏 (module!) |
2. 关键代码结构解析
lib.rs 通过模块化组织,将复杂的内核逻辑转化为符合 Rust 习惯的接口。以下是其核心组成部分的代码实现示例:
2.1 模块声明与入口
文件顶部定义了 crate 的元数据和核心模块引用,确立了命名空间 。
rust
// rust/kernel/lib.rs核心结构示意
#![no_std]
#![feature(allocator_api)]
#![feature(pin_macro)]// 1. 基础类型与 FFI 定义
pub mod ffi;
pub mod types; // 包含 Opaque, ForeignOwnable
pub mod error; // 包含 Error, Result
// 2. 核心子系统抽象
pub mod alloc; // 内存分配 (Box, Vec, Arc)
pub mod sync; // 同步原语 (Mutex, SpinLock)
pub mod device; // 通用设备模型
pub mod driver; // 驱动框架核心
// 3. 总线与硬件抽象
pub mod pci;
pub mod usb;
pub mod i2c;
pub mod platform;
// 4. 高级功能
pub mod fs; // 文件系统
pub mod net; // 网络栈
pub mod module; // 模块加载宏
// 预导出常用项,方便驱动开发者 use kernel::prelude::*
pub mod prelude {
pub use crate::{Error, Result};
pub use crate::alloc::{Box, Vec, Arc};
pub use crate::sync::{Mutex, SpinLock}; pub use crate::device::Device;
pub use crate::module::Module;
}
2.2 错误处理体系
定义了基于内核 errno 的错误类型,替代 C 语言的整数返回值,强制调用者处理错误 。
rust
// kernel/error.rs 逻辑封装
#[repr(transparent)]
pub struct Error(core::num::NonZeroI32);
/// 标准结果类型别名
pub type Result<T = (), E = Error> = core::result::Result<T, E>;
impl Error {
/// 常见错误码常量
pub const EINVAL: Self = Self::new(bindings::EINVAL);
pub const ENOMEM: Self = Self::new(bindings::ENOMEM);
/// 从 C 函数返回值转换 (负数转为 Err)
pub fn from_errno(err: i32) -> Self {
// 确保错误码非零
Self::new(unsafe { core::num::NonZeroI32::new_unchecked(-err) })
}
}
2.3 设备模型与类型状态
利用泛型参数 Ctx 实现设备生命周期的编译期检查,防止非法状态访问 。
rust
// kernel/device.rs 逻辑封装
use crate::types::{Opaque, PhantomData};
/// 设备上下文 Trait,标记设备状态
pub trait DeviceContext {}
/// 具体状态类型
pub struct Normal;
pub struct Core<'a>(&'a ());
pub struct Bound;
impl DeviceContext for Normal {}
impl<'a> DeviceContext for Core<'a> {}
impl DeviceContext for Bound {}
/// 泛型设备结构体
/// Ctx 参数强制区分设备处于未初始化、探测中还是已绑定状态
#[repr(transparent)]
pub struct Device<Ctx: DeviceContext = Normal>(
Opaque<bindings::device>,
PhantomData<Ctx>,
);
impl<Ctx: DeviceContext> Device<Ctx> {
/// 所有状态均可访问的基本属性
pub fn name(&self) -> &core::ffi::CStr {
unsafe { core::ffi::CStr::from_ptr((*self.0.get()).name) }
}
}
/// 仅在 Bound 状态下可用的方法
impl Device<Bound> {
pub fn get_driver_data<T>(&self) -> &T {
// 安全地访问驱动私有数据
unsafe { &*bindings::dev_get_drvdata(self.0.get()) as *const T }
}
}
3. 使用场景示例
开发者在编写内核模块时,通过 use kernel::prelude::* 引入由 lib.rs 导出的核心能力,实现类型安全的驱动逻辑 。
rust
// 示例:一个简单的平台驱动use kernel::prelude::*;
use kernel::{platform, device, module};
#[pin_data]
struct MyDriverData {
#[pin]
lock: Mutex<u32>,
}
struct MyDriver;
impl platform::Driver for MyDriver {
type IdInfo = ();
type Data<'bound> = MyDriverData;
const OF_ID_TABLE: Option<of::IdTable<Self::IdInfo>> = None;
fn probe<'bound>(
dev: &'bound platform::Device<device::Core<'_>>,
_id_info: Option<&'bound Self::IdInfo>,
) -> impl PinInit<Self::Data<'bound>, Error> + 'bound {
// 利用 lib.rs 提供的 PinInit 进行安全初始化
try_pin_init! {
Self::Data<'_> {
lock <- new_mutex!(0),
}
}
}
}
module_platform_driver! {
type: MyDriver,
name: "rust_sample_driver",
license: "GPL v2",
}
通过 rust/kernel/lib.rs 的模块化设计,Linux 内核成功将 C 语言的隐式约定转化为 Rust 的显式类型约束,确保了内核态代码的内存安全性与逻辑正确性 。