debugfs_create_fileLinux中debugfs的解析debugfs_remove_recursiveDEFINE_SIMPLE

本文主要是介绍debugfs_create_fileLinux中debugfs的解析debugfs_remove_recursiveDEFINE_SIMPLE_ATTRIBUTE，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Linux中debugfs的解析

2016年06月27日 17:56:17

阅读数：1088

debugfs_create_dir和debugfs_create_file定义在fs/debugfs/inode.c，函数原型声明在include/linux/fs.h。

struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
struct dentry *debugfs_create_file(const char *name, umode_t mode, struct dentry *parent, void *data, const struct file_operations *fops);
name是创建的文件或目录的名字，mode是文件的权限，parent是父目录，data通常指向驱动程序分配的数据，fops指向驱动分配的file_operations结构体，该结构体指定了应用程序读写时对调用的驱动程序函数。
对应的remove函数：
void debugfs_remove_recursive(struct dentry *dentry);
参数是调用debugfs_create_dir函数返回的指针。

配置CONFIG_DEBUG_FS=y让内核支持debugfs，也可以在menuconfig中指定：
Kernel hacking --->
[*] Debug Filesystem
内核默认会将debugfs挂载在/sys/kernel/debug目录下，也可以指定挂载目录：mount -t debugfs none /mnt
使用debugfs文件系统调试，先用宏DEFINE_SIMPLE_ATTRIBUTE指定使用读写函数和可变参数的格式，然后调用debugfs_create_dir和debugfs_create_file在文件系统下面创建文件，执行cat和echo时，会调用驱动的读写函数。

DEFINE_SIMPLE_ATTRIBUTE宏定义在include/linux/fs.h。
#define DEFINE_SIMPLE_ATTRIBUTE(__fops, __get, __set, __fmt)       \
static int __fops ## _open(struct inode *inode, struct file *file)   \
{                                   \
   __simple_attr_check_format(__fmt, 0ull);           \
   return simple_attr_open(inode, file, __get, __set, __fmt);   \
}                                   \
static const struct file_operations __fops = {               \
   .owner   = THIS_MODULE,                       \
   .open   = __fops ## _open,                   \
   .release = simple_attr_release,                   \
   .read   = simple_attr_read,                   \
   .write   = simple_attr_write,                   \
   .llseek   = generic_file_llseek,                   \
};

DEFINE_SIMPLE_ATTRIBUTE定义了一个file_operations结构体，并指定了open，read，write等函数，simple_attr_open函数关联了驱动的read，write函数，应用程序read，write时，通过simple_attr_read和simple_attr_write来调用驱动程序的read，write函数。
int simple_attr_open(struct inode *inode, struct file *file, int (*get)(void *, u64 *), int (*set)(void *, u64), const char *fmt)
{
   struct simple_attr *attr;

   attr = kmalloc(sizeof(*attr), GFP_KERNEL);
   if (!attr)
       return -ENOMEM;

   attr->get = get;
   attr->set = set;
   attr->data = inode->i_private;
   attr->fmt = fmt;
   mutex_init(&attr->mutex);

   file->private_data = attr;

   return nonseekable_open(inode, file);
}

attr->get和attr->set分别指向驱动的get和set函数。attr->data指向了驱动分配的数据，在调用debugfs_create_file时，该函数会inode->i_private指正指向第四个参数，这个参数一般是驱动程序的数据指针。
ssize_t simple_attr_read(struct file *file, char __user *buf,
           size_t len, loff_t *ppos)
{
   struct simple_attr *attr;
   size_t size;
   ssize_t ret;

   attr = file->private_data;

   if (!attr->get)
       return -EACCES;

   ret = mutex_lock_interruptible(&attr->mutex);
   if (ret)
       return ret;

   if (*ppos) {       /* continued read */
       size = strlen(attr->get_buf);
   } else {       /* first read */
       u64 val;
       ret = attr->get(attr->data, &val);
       if (ret)
           goto out;

       size = scnprintf(attr->get_buf, sizeof(attr->get_buf),
               attr->fmt, (unsigned long long)val);
   }

   ret = simple_read_from_buffer(buf, len, ppos, attr->get_buf, size);
out:
   mutex_unlock(&attr->mutex);
   return ret;
}

通过attr = file->private_data;获得在simple_attr_open函数分配的attr结构体地址，然后ret = attr->get(attr->data, &val);用来调用驱动的get函数，读取到的值存放在val中，最后调用scnprintf函数将val按照DEFINE_SIMPLE_ATTRIBUTE中定义的字符串格式返回到simple_attr结构体的get_buf字符数组。
ssize_t simple_attr_write(struct file *file, const char __user *buf,
              size_t len, loff_t *ppos)
{
   struct simple_attr *attr;
   u64 val;
   size_t size;
   ssize_t ret;

   attr = file->private_data;
   if (!attr->set)
       return -EACCES;

   ret = mutex_lock_interruptible(&attr->mutex);
   if (ret)
       return ret;

   ret = -EFAULT;
   size = min(sizeof(attr->set_buf) - 1, len);
   if (copy_from_user(attr->set_buf, buf, size))
       goto out;

   attr->set_buf[size] = '\0';
   val = simple_strtoll(attr->set_buf, NULL, 0);
   ret = attr->set(attr->data, val);
   if (ret == 0)
       ret = len; /* on success, claim we got the whole input */
out:
   mutex_unlock(&attr->mutex);
   return ret;
}
首先和simple_attr_read一样获得attr的地址，然后调用copy_from_user获得echo传入的参数，接着利用simple_strtoll将字符传格式的数字转换为整型，最后调用驱动的set函数，将值写入attr->data中。