Linux 驱动创建Proc文件系统接口

      

目录

它有什么作用呢？

驱动如何实现？

详细实现分析

---

         Linux的procfs文件系统是一个虚拟文件系统，Linux不只有一个虚拟文件系统，sysfs和debugfs也是虚拟文件系统，sysfs在procfs的基础上进行了优化。虚拟文件系统在系统运行时创建，存在于内存。

它有什么作用呢？

         它是一种在运行时访问内核内部数据结构、改变内核设置的机制。proc文件系统是一个伪文件系统，它只存在内存当中，而不占用外存空间。它以文件系统的方式为访问系统内核数据的操作提供接口。用户和应用程序可以通过proc得到系统的信息，并可以改变内核的某些参数。由于系统的信息，如进程，是动态改变的，所以用户或应用程序读取proc文件时，proc文件系统是动态从系统内核读出所需信息并提交的。

驱动如何实现？

        下面以一个简单的示例来展示驱动中怎么实现proc接口

#include <linux/proc_fs.h>
#include <linux/slab.h>
#include <linux/uaccess.h>
#include <linux/err.h>


#define TEST_PROC_DIR              "test_dir"
#define TEST_PROC_NAME             "test_val"

struct proc_dir_entry *test_proc_dir = NULL;


static struct test_device {
	struct device *dev;
	struct platform_device *pdev;
};

struct test_device test_dev;

static int test_proc_write(struct file *file, const char __user *buffer, size_t count, loff_t *f_pos){
	int i;
	
	char *tmp = kzalloc((count + 1), GFP_KERNEL);
	if(!tmp){
		return -ENOMEM;
	}
	
	
	memset(tmp, 0x00, count+1);
	printk("TMP =%s count =%d\n", tmp, count);
	if(copy_from_user(tmp, buffer, count)){
		kfree(tmp);
		return -EFAULT;
	}

	printk("Get from user %s\n", tmp);

	
	for(i = 0; i < count; i++){
		printk("[%d] 0x%x ", i, tmp[i]);
	}
	printk("\n");
	
	
	kfree(tmp);
	return count;
	
}

ssize_t test_proc_read(struct file *file, char __user *buffer, size_t len, loff_t *off){

	pr_err("Set to user\n");
	return 0;

}

static struct file_operations proc_fops = {
	.owner = THIS_MODULE,
	.read = test_proc_read,
	.write = test_proc_write,
};

static int init_test_proc(void)
{
	struct proc_dir_entry *file;
	
	test_proc_dir = proc_mkdir(TEST_PROC_DIR, NULL);
	if(NULL == test_proc_dir){
		pr_err("%s Create %s failed\n", __func__, TEST_PROC_DIR);
		return -EINVAL;
	}

	file = proc_create(TEST_PROC_NAME, 666, test_proc_dir,  &proc_fops);
	if(!file){
		pr_err("%s Create %s failed\n", __func__, TEST_PROC_NAME);
		return -EINVAL;
	}

	return 0;
}

static int __init proc_test_init(void)
{
	int ret = 0;
	test_dev.pdev = platform_device_register_simple("test-proc",
                                                   0, NULL, 0);
	if (IS_ERR(test_dev.pdev)) {
		ret = PTR_ERR(test_dev.pdev);
		pr_err("%s platform_device_register_simple \n", __func__);
		goto out;
	}

	init_test_proc();

out:
	return ret;
}



static void proc_test_exit(void)
{
	platform_device_unregister(test_dev.pdev);
}

module_init(proc_test_init);
module_exit(proc_test_exit);

MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("driver for proc ");
MODULE_ALIAS("platform:proc");

详细实现分析

        以上有两个重要的函数proc_mkdir，proc_create，具体函数原型如下

        先看proc_mkdir

struct proc_dir_entry *proc_mkdir(const char *name,
		struct proc_dir_entry *parent)
{
	return proc_mkdir_data(name, 0, parent, NULL);
}

struct proc_dir_entry *proc_mkdir_data(const char *name, umode_t mode,
		struct proc_dir_entry *parent, void *data)
{
	struct proc_dir_entry *ent;

	if (mode == 0)
		mode = S_IRUGO | S_IXUGO;

	ent = __proc_create(&parent, name, S_IFDIR | mode, 2);
	if (ent) {
		ent->data = data;
		ent->proc_fops = &proc_dir_operations;
		ent->proc_iops = &proc_dir_inode_operations;
		parent->nlink++;
		if (proc_register(parent, ent) < 0) {
			kfree(ent);
			parent->nlink--;
			ent = NULL;
		}
	}
	return ent;
}

static struct proc_dir_entry *__proc_create(struct proc_dir_entry **parent,
					  const char *name,
					  umode_t mode,
					  nlink_t nlink)
{
	........

	if (xlate_proc_name(name, parent, &fn) != 0)
		goto out;
	..........

out:
	return ent;
}

static int xlate_proc_name(const char *name, struct proc_dir_entry **ret,
			   const char **residual)
{
	int rv;

	read_lock(&proc_subdir_lock);
	rv = __xlate_proc_name(name, ret, residual);
	read_unlock(&proc_subdir_lock);
	return rv;
}

static int __xlate_proc_name(const char *name, struct proc_dir_entry **ret,
			     const char **residual)
{
	........

	de = *ret;
	if (!de)
		de = &proc_root;

	......
	return 0;
}

        顺着proc_mkdir--》__proc_create--》xlate_proc_name--》__xlate_proc_name追下来，可以发现如果proc_mkdir指定parent为NULL，它默认以proc_root为parent，也就是在/proc/下创建name节点。

        再看proc_create

struct proc_dir_entry *proc_create(const char *name, umode_t mode,
				   struct proc_dir_entry *parent,
				   const struct file_operations *proc_fops)
{
	return proc_create_data(name, mode, parent, proc_fops, NULL);
}

struct proc_dir_entry *proc_create_data(const char *name, umode_t mode,
					struct proc_dir_entry *parent,
					const struct file_operations *proc_fops,
					void *data)
{
	struct proc_dir_entry *pde;
	if ((mode & S_IFMT) == 0)
		mode |= S_IFREG;

	if (!S_ISREG(mode)) {
		WARN_ON(1);	/* use proc_mkdir() */
		return NULL;
	}

	BUG_ON(proc_fops == NULL);

	if ((mode & S_IALLUGO) == 0)
		mode |= S_IRUGO;
	pde = __proc_create(&parent, name, mode, 1);
	if (!pde)
		goto out;
	pde->proc_fops = proc_fops;
	pde->data = data;
	pde->proc_iops = &proc_file_inode_operations;
	if (proc_register(parent, pde) < 0)
		goto out_free;
	return pde;
out_free:
	kfree(pde);
out:
	return NULL;
}

        可以看到它和上面的proc_mkdir一样都调用了__proc_create这个函数，这样两者统一起来。这里需要注意proc_create是在kernel 3.10以及之后的版本中新增的，用于替换之create_proc_entry，如果是用create_proc_entry该如何实现呢？

{
    test_dir = proc_mkdir(TEST_PROC_DIR, NULL);
    if(!test_dir)
        return -ENOMEM;

    test_dir = create_proc_entry(TEST_PROC_NAME, 0644, test_dir);
    if(!test_dir )
        return -ENOMEM;
    test_dir->read_proc = test_proc_read;
    test_dir->write_proc = test_proc_write;
}

        proc_mkdir和proc_create两个输入参数的差别是proc_create多了mode、file_operation，而proc_mkdir在proc_mkdir_data中默认指定mode=0，file_operation为NULL，但是在proc_mkdir_data的实现中指定mode = S_IRUGO | S_IXUGO;对应的文件操作为全局的ent->proc_fops = &proc_dir_operations；

static const struct file_operations proc_dir_operations = {
	.llseek			= generic_file_llseek,
	.read			= generic_read_dir,
	.iterate_shared		= proc_readdir,
};

        在用户层可以直接访问/proc/test_dir/test_val，用户可以直接读里面test_val，也可以往test_val写，对应的驱动接口test_proc_read、test_proc_write。