【Linux驱动开发】Linux Sysfs 虚拟文件系统深度解析与实战指南

Linux Sysfs 虚拟文件系统深度解析与实战指南

1. 基础概念 (Basic Concepts)

1.1 定义与本质

Sysfs 是 Linux 内核提供的一种虚拟文件系统（Virtual Filesystem），通常挂载在 /sys 目录下。

官方定义: Sysfs 是一个基于内存的文件系统，它提供了一种机制，将内核数据结构、对象属性以及它们之间的关系导出到用户空间。
核心作用: 它直观地展示了系统中的设备驱动模型（Device Driver Model），包括设备（Devices）、驱动（Drivers）和总线（Buses）的层次结构。
交互方式 : 用户可以通过标准的文件 I/O 操作（如 read、write）来查询设备状态或修改内核参数，实现了内核与用户空间的双向交互。

1.2 历史演进

Sysfs 的诞生是为了解决 Linux 早期内核中信息混乱的问题。

Linux 2.4 及以前 : 系统信息主要混杂在 /proc 文件系统中。/proc 最初仅用于进程信息，后来被滥用于存放各种非进程相关的驱动和系统数据，导致结构混乱且缺乏统一标准。
Linux 2.5 (开发分支) : Patrick Mochel 引入了 统一设备模型 (Linux Device Model) 和 kobject 基础设施。为了将这个复杂的对象模型可视化，Sysfs 应运而生（最初称为 driverfs）。
Linux 2.6 : Sysfs 正式合并入主线内核，并固定挂载点为 /sys。它强制实施了"一个文件对应一个值"的设计原则，极大地提高了系统接口的清晰度。

1.3 Sysfs vs Procfs vs Debugfs

虽然它们都是基于内存的虚拟文件系统，但定位截然不同：

特性	Sysfs (`/sys`)	Procfs (`/proc`)	Debugfs (`/sys/kernel/debug`)
核心职责	展示设备模型、硬件拓扑、驱动控制	展示进程状态、内存信息、系统统计	供开发人员调试内核使用
结构规范	严格。强制分层，通常每个文件只包含一个值	较宽松。文件内容格式多样 (如 `meminfo`)	无限制。完全由开发者决定
稳定性	ABI 级稳定。用户空间工具 (如 udev) 依赖它	部分稳定。核心文件稳定，驱动部分不建议依赖	不稳定。随时可能变动，不应在生产环境依赖
挂载方式	默认挂载	默认挂载	需手动挂载

2. 技术实现机制 (Technical Implementation)

2.1 核心对象：Kobject

kobject (Kernel Object) 是 Linux 设备模型中最基础的数据结构，定义在 <linux/kobject.h> 中。它不仅是 sysfs 目录背后的实体，还负责管理内核对象的生命周期。

关键作用:

引用计数 (Reference Counting) : 通过 kref 成员管理对象的生命周期，当计数为 0 时自动释放内存。
层次结构 (Hierarchy) : 通过 parent 指针将对象连接成树状结构，这直接对应了 /sys 下的目录层级。
Sysfs 表示 : 每个 kobject 在 sysfs 中对应一个目录。

2.2 Kobject 与 Sysfs 映射

Sysfs 的目录结构是内核中 kobject 树的直接映射。

目录 (Directory) : 对应内核中的 struct kobject。
文件 (File) : 对应内核中的 struct attribute。
符号链接 (Symlink): 对应对象之间的关联关系。

User_Space_Sysfs Kernel_Space contains Mapped to Mapped to Directory (/sys/devices/...) File (e.g., power/state) struct kobject struct attribute

2.3 Sysfs 操作集 (sysfs_ops)

当用户在用户空间读写 sysfs 文件时，VFS 会将操作转发给 sysfs，最终调用 sysfs_ops 中定义的回调函数。

c 复制代码

struct sysfs_ops {
    ssize_t (*show)(struct kobject *, struct attribute *, char *);
    ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
};

show() : 对应 read 操作。将内核数据格式化为字符串，复制到用户缓冲区。
store() : 对应 write 操作。解析用户传入的字符串，更新内核数据。

3. 核心功能与目录结构 (Core Functions)

3.1 目录结构解析

/sys 下的顶层目录代表了内核设备模型的不同视图。

目录	描述 (Description)	示例
block/	系统中所有的块设备（已废弃，现多为指向 `/sys/devices` 的符号链接）	`sda`, `nvme0n1`
bus/	系统中的总线类型。包含 `devices`（挂载的设备）和 `drivers`（已加载的驱动）	`usb`, `pci`, `i2c`
class/	按功能分类的设备视图。不关心连接方式，只关心功能	`net` (网络接口), `input` (输入设备)
dev/	维护了字符设备 (`char`) 和块设备 (`block`) 的主次设备号映射	`char/1:1` -> `../../devices/...`
devices/	全局设备树。这是所有设备的真实物理层次结构视图，其他目录多为指向此处的符号链接	`pci0000:00/...`
firmware/	固件相关接口	`efi`, `acpi`
kernel/	内核相关配置参数（部分替代 `/proc/sys`）	`uevent_seqnum`, `tracing`
module/	已加载的内核模块信息	`ext4`, `usbcore`

3.2 USB 设备树示例

以一个 USB 鼠标为例，展示其在 /sys/devices 中的完整物理路径：

bash 复制代码

/sys/devices/pci0000:00/0000:00:14.0/usb1/1-1/1-1:1.0/

pci0000:00: PCI 总线根控制器
0000:00:14.0: USB xHCI 控制器 (PCI 设备)
usb1: USB Root Hub
1-1: 连接在 Port 1 的 USB 设备 (鼠标)
1-1:1.0: 该设备的第 0 号接口 (Interface)

3.3 用户空间交互

用户可以通过 shell 命令轻松地与 sysfs 交互。

3.3.1 读取参数

查看网卡的 MAC 地址：

bash 复制代码

cat /sys/class/net/eth0/address
# 输出: 00:15:5d:01:ca:03

3.3.2 修改参数

控制键盘上的 LED 灯（ScrollLock）：

bash 复制代码

# 1 表示点亮，0 表示熄灭
echo 1 | sudo tee /sys/class/leds/input0::scrolllock/brightness

3.3.3 权限管理 (udev)

默认情况下，普通用户无法写入大部分 sysfs 文件。通过编写 udev 规则，可以修改特定设备的权限。

示例 : 允许 dialout 组用户控制 USB 转串口设备。

文件 /etc/udev/rules.d/99-usb-serial.rules:

bash 复制代码

SUBSYSTEM=="tty", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6001", MODE="0660", GROUP="dialout"

4. 开发实践 (Development Practice)

4.1 驱动集成示例

本节将演示如何在 Linux 字符设备驱动中添加一个名为 status 的 sysfs 属性文件，用户可以通过它读取或修改驱动内部的状态变量。

4.1.1 完整代码示例

c 复制代码

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/fs.h>
#include <linux/sysfs.h>
#include <linux/kobject.h>
#include <linux/string.h>

static struct kobject *my_kobj;
static int my_value = 0;

/* 1. 实现 show (read) 回调 */
static ssize_t my_value_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf)
{
    return sprintf(buf, "%d\n", my_value);
}

/* 2. 实现 store (write) 回调 */
static ssize_t my_value_store(struct kobject *kobj, struct kobj_attribute *attr,
                             const char *buf, size_t count)
{
    int ret;
    
    // 将字符串转换为整数
    ret = kstrtoint(buf, 10, &my_value);
    if (ret < 0)
        return ret;
        
    return count;
}

/* 3. 定义属性 (文件名为 "status", 权限为 0664) */
static struct kobj_attribute my_attribute =
    __ATTR(status, 0664, my_value_show, my_value_store);

/* 4. 模块初始化 */
static int __init my_sysfs_init(void)
{
    int ret;

    // 在 /sys/kernel/ 下创建一个名为 "my_custom_sysfs" 的目录
    my_kobj = kobject_create_and_add("my_custom_sysfs", kernel_kobj);
    if (!my_kobj)
        return -ENOMEM;

    // 在该目录下创建文件 "status"
    ret = sysfs_create_file(my_kobj, &my_attribute.attr);
    if (ret) {
        kobject_put(my_kobj);
        return ret;
    }

    printk(KERN_INFO "Sysfs Example Loaded\n");
    return 0;
}

/* 5. 模块卸载 */
static void __exit my_sysfs_exit(void)
{
    kobject_put(my_kobj); // 自动清理目录和文件
    printk(KERN_INFO "Sysfs Example Unloaded\n");
}

module_init(my_sysfs_init);
module_exit(my_sysfs_exit);
MODULE_LICENSE("GPL");

4.1.2 测试验证

bash 复制代码

# 加载模块
sudo insmod my_sysfs.ko

# 读取初始值
cat /sys/kernel/my_custom_sysfs/status
# 输出: 0

# 修改值
echo 42 | sudo tee /sys/kernel/my_custom_sysfs/status

# 再次读取
cat /sys/kernel/my_custom_sysfs/status
# 输出: 42

4.2 调试技巧

在开发 sysfs 接口时，可能会遇到文件未创建、权限错误或内核崩溃等问题。

检查目录结构 : 使用 tree /sys/kernel/my_custom_sysfs 确认目录和文件是否已生成。
查看内核日志 : 如果 kobject_create_and_add 失败，dmesg 通常会打印错误原因（如命名冲突）。
使用 Debugfs 辅助: 如果 sysfs 逻辑复杂，建议配合 debugfs 暴露更原始的调试信息，避免污染 sysfs 的规范结构。

5. 参考文献 (References)

Linux Kernel Documentation : Documentation/filesystems/sysfs.txt
LWN.net : The driver model core
Linux Device Drivers, 3rd Edition: Chapter 14 - The Linux Device Model