Seq_file File System实例剖析

末蓝、 2022-03-26 15:46 435阅读 0赞

Seq\_file File System实例剖析

针对proc文件的不足而诞生了Seq\_file。  
Seq\_file的实现基于proc文件。使用Seq\_file，用户必须抽象出一个链接对象，然后可以依次遍历这个链接对象。这个链接对象可以是链表，数组，哈希表等等。  
编程接口  
Seq\_file必须实现四个操作函数：start(), next(), show(), stop()。

<table> 
 <tbody> 
 <tr> 
 <td>struct seq_operations { &nbsp;&nbsp;&nbsp;&nbsp;void * (*start) (struct seq_file *m, loff_t *pos); &nbsp;&nbsp;&nbsp;&nbsp;void (*stop) (struct seq_file *m, void *v); &nbsp;&nbsp;&nbsp;&nbsp;void * (*next) (struct seq_file *m, void *v, loff_t *pos); &nbsp;&nbsp;&nbsp;&nbsp;int (*show) (struct seq_file *m, void *v); };</td> 
 </tr> 
 </tbody> 
</table>

start()：  
主要实现初始化工作，在遍历一个链接对象开始时，调用。返回一个链接对象的偏移或者SEQ\_START\_TOKEN（表征这是所有循环的开始）。出错返回ERR\_PTR。  
stop():  
当所有链接对象遍历结束时调用。主要完成一些清理工作。  
next():  
用来在遍历中寻找下一个链接对象。返回下一个链接对象或者NULL（遍历结束）。  
show():  
对遍历对象进行操作的函数。主要是调用seq\_printf(), seq\_puts()之类的函数，打印出这个对象节点的信息。  
下图描述了seq\_file函数对一个链表的遍历。  
  
2、重要的数据结构  
除了struct seq\_operations以外，另一个最重要的数据结构是struct seq\_file：  
struct seq\_file \{  
        char \*buf;  
        size\_t size;  
        size\_t from;  
        size\_t count;  
        loff\_t index;  
        u64 version;  
        struct mutex lock;  
        const struct seq\_operations \*op;  
        void \*private;  
\};  
该结构会在seq\_open函数调用中分配，然后作为参数传递给每个seq\_file的操作函数。Privat变量可以用来在各个操作函数之间传递参数。  
  
3、Seq\_file使用示例：

<table> 
 <tbody> 
 <tr> 
 <td>#include &lt;net/net_namespace.h&gt; /* for use of init_net*/ #include &lt;linux/kernel.h&gt; /* We're doing kernel work */ #include &lt;linux/module.h&gt; /* Specifically, a module */ #include &lt;linux/proc_fs.h&gt; /* Necessary because we use proc fs */ #include &lt;linux/seq_file.h&gt; /* for seq_file */ #define PROC_NAME "my_seq_proc" MODULE_AUTHOR("Dreamice：<a href="mailto:dreamice.jiang@mail.com" rel="nofollow">dreamice.jiang@mail.com</a>"); MODULE_LICENSE("GPL"); static void *my_seq_start(struct seq_file *s, loff_t *pos) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;static unsigned long counter = 0; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"Invoke start\n"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/* beginning a new sequence ? */ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if ( *pos == 0 ) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/* yes =&gt; return a non null value to begin the sequence */ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"pos == 0\n"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return &amp;counter; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;else &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/* no =&gt; it's the end of the sequence, return end to stop reading */ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*pos = 0; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"pos != 0\n"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return NULL; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} } static void *my_seq_next(struct seq_file *s, void *v, loff_t *pos) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned long *tmp_v = (unsigned long *)v; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"Invoke next\n"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(*tmp_v)++; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(*pos)++; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return NULL; } static void my_seq_stop(struct seq_file *s, void *v) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"Invoke stop\n"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/* nothing to do, we use a static value in start() */ } static int my_seq_show(struct seq_file *s, void *v) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"Invoke show\n"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;loff_t *spos = (loff_t *) v; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;seq_printf(s, "%Ld\n", *spos); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return 0; } static struct seq_operations my_seq_ops = { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.start = my_seq_start, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.next = my_seq_next, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.stop = my_seq_stop, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.show = my_seq_show }; static int my_open(struct inode *inode, struct file *file) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return seq_open(file, &amp;my_seq_ops); }; static struct file_operations my_file_ops = { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.owner = THIS_MODULE, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.open = my_open, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.read = seq_read, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.llseek = seq_lseek, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.release = seq_release }; int init_module(void) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;struct proc_dir_entry *entry; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;entry = create_proc_entry(PROC_NAME, 0, init_net.proc_net); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (entry) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;entry-&gt;proc_fops = &amp;my_file_ops; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"Initialze my_seq_proc success!\n"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return 0; } /** * This function is called when the module is unloaded. * */ void cleanup_module(void) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;remove_proc_entry(PROC_NAME, init_net.proc_net); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;printk(KERN_INFO"Remove my_seq_proc success!\n"); } </td> 
 </tr> 
 </tbody> 
</table>

该程序在/proc/net下注册一个my\_seq\_proc文件。有兴趣的朋友可以测试一下。