Linux内核 -- 使用 `proc_create_seq` 和 `seq_operations` 快速创建 /proc 文件

使用 proc_create_seq 和 seq_operations 创建 /proc 文件

本教程将介绍如何使用 proc_create_seq 和 seq_operations 在 Linux 内核中创建 /proc 文件。通过这些接口，您可以轻松实现序列化读取内核数据的功能。

1. seq_operations 回调函数

seq_operations 结构体中定义了一组回调函数，用于控制如何读取和遍历数据。以下是这些回调函数的定义和作用：

struct seq_operations {
    void * (*start) (struct seq_file *m, loff_t *pos);  // 初始化读取
    void (*stop) (struct seq_file *m, void *v);         // 停止读取，释放资源
    void * (*next) (struct seq_file *m, void *v, loff_t *pos);  // 获取下一项
    int (*show) (struct seq_file *m, void *v);          // 打印当前数据项
};

1.1 start 函数

start 函数用于初始化读取操作，返回当前要读取的第一个数据项。如果读取结束，返回 NULL。

1.2 next 函数

next 函数用于遍历数据，返回下一项。如果到达末尾，返回 NULL。

1.3 stop 函数

stop 函数在数据读取结束时调用，用于清理资源。

1.4 show 函数

show 函数将当前数据项打印到用户空间的 seq_file 中。

2. 示例代码：回调函数的实现

以下是 seq_operations 回调函数的示例代码：

static void *my_seq_start(struct seq_file *s, loff_t *pos) {
    if (*pos >= nr_of_entries)
        return NULL;  // 没有更多数据
    return &my_data[*pos];  // 返回当前数据
}

static void *my_seq_next(struct seq_file *s, void *v, loff_t *pos) {
    (*pos)++;  // 增加偏移量
    if (*pos >= nr_of_entries)
        return NULL;  // 读取结束
    return &my_data[*pos];  // 返回下一个数据项
}

static void my_seq_stop(struct seq_file *s, void *v) {
    // 清理资源（如果需要）
}

static int my_seq_show(struct seq_file *s, void *v) {
    int *entry = (int *)v;
    seq_printf(s, "Data: %d", *entry);  // 输出数据项
    return 0;
}

3. 定义 seq_operations 结构

接下来，我们需要将这些回调函数与 seq_operations 结构体关联：

static const struct seq_operations my_seq_ops = {
    .start = my_seq_start,
    .next  = my_seq_next,
    .stop  = my_seq_stop,
    .show  = my_seq_show
};

4. 初始化和卸载模块

最后，我们通过 proc_create_seq 创建 /proc 文件，并在模块卸载时删除该文件。

static int __init my_module_init(void) {
    proc_create_seq("my_seq_file", 0, NULL, &my_seq_ops);
    return 0;
}

static void __exit my_module_exit(void) {
    remove_proc_entry("my_seq_file", NULL);
}

module_init(my_module_init);
module_exit(my_module_exit);

MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("使用 proc_create_seq 的示例");
MODULE_AUTHOR("ChatGPT");

5. 使用 file_operations 的方式创建 /proc 文件

以下代码展示了如何通过 proc_create_seq 创建 /proc 文件：

static int my_proc_open(struct inode *inode, struct file *file) {
    return seq_open(file, &my_seq_ops);  // 关联 seq_operations
}

static const struct file_operations my_proc_fops = {
    .owner   = THIS_MODULE,
    .open    = my_proc_open,
    .read    = seq_read,
    .llseek  = seq_lseek,
    .release = seq_release
};

6. 编译与测试

保存文件并使用以下命令编译和加载模块：

make -C /lib/modules/$(uname -r)/build M=$(pwd) modules
sudo insmod my_module.ko

然后使用 cat /proc/my_seq_file 命令查看输出：

$ cat /proc/my_seq_file
Data: 1
Data: 2
Data: 3
Data: 4
Data: 5

卸载模块：

sudo rmmod my_module

这样，我们通过 proc_create_seq 成功创建了 /proc 文件并实现了序列化输出数据。