使用debugfs

在前面，我们学习到了sysctl这一基于sysfs和seq_file这一基于procfs文件系统进行交互数据的方式，其中procfs主要是针对进程属性，而sysfs是针对内核模型的，为了保证其稳健，我们很少拿来作为调试时数据交换使用，显然printk也满足不了，那么debugfs就应运而生了.
一般发行版系统会将debugfs挂载在/sys/kernel/debug这一目录下，在/etc/mtab有相关内容，如果没有，也可手动执行如下命令：
mount -t debufgs none /the/debugfs/dir
在include/linux/debugfs.h文件里有debugfs用到的如下函数：
static inline struct dentry *debugfs_create_dir(const char *name, struct dentry *parent);
static inline struct dentry *debugfs_create_file(const char *name, umode_t mode,
struct dentry *parent, void *data, const struct file_operations *fops);
static inline void debugfs_remove(struct dentry *dentry) ;
static inline void debugfs_remove_recursive(struct dentry *dentry) ;
很像前面procfs时的相关函数吧，这就不作解释了，还会用到如下函数：
static inline struct dentry *debugfs_create_u8(const char *name, umode_t mode,
        struct dentry *parent, u8 *value) ;
static inline struct dentry *debugfs_create_u16(const char *name, umode_t mode,
        struct dentry *parent, u16 *value);
static inline struct dentry *debugfs_create_u32(const char *name, umode_t mode,
        struct dentry *parent, u32 *value) ;
static inline struct dentry *debugfs_create_u64(const char *name, umode_t mode,
        struct dentry *parent, u64 *value) ;
这些都是单值文件，还有将上面函数名中的u8、u16、u32、u64替换为x8、x16、x32、x64的函数，这些表示后面的value用16进制数表示。还有size_t、atomic_t、bool等类型的函数，以及跟数组相关的BLOB文件：
static inline struct dentry *debugfs_create_blob(const char *name, umode_t mode,
        struct dentry *parent, struct debugfs_blob_wrapper *blob) ;
还有更多的相关函数请在debugfs.h了解，上面函数中debugfs_blog_wrapper结构体定义如下：
struct debugfs_blob_wrapper {
       void *data;
       unsigned long size;
};
至此，我们了解了相关函数说明，接下来上实例吧：
/*
This module will create debugfs example module,
the directory tree will be created,like:
/sys/kernel/debug (The debugfs mount node)
|_slam_debug
|
|_slam
| |_array
|_array
|_u8
*/
#include <linux/module.h>
#include <linux/debugfs.h>
#include <asm/uaccess.h>

MODULE_LICENSE("GPL");

#define MAX_SLAM_SIZE 32

static struct dentry * slam_debug_dir, * slam_dir;
static u8 u8_var;
static char array[32] = "Hello xinu!\n";
static struct debugfs_blob_wrapper bw;

static int slam_open(struct inode *inode, struct file *filp)
{
        filp->private_data = inode->i_private;
        return 0;
}

static ssize_t slam_read(struct file *filp, char __user *buf, size_t count, loff_t *ppos)
{
        if(*ppos >= MAX_SLAM_SIZE)
                return 0;

        if(*ppos + count > MAX_SLAM_SIZE)
                count = MAX_SLAM_SIZE - *ppos;

        if(copy_to_user(buf, array + *ppos, count))
                return -EFAULT;

        *ppos += count;

        return count;
}

static ssize_t slam_write(struct file *filp, const char __user *buf, size_t count, loff_t *ppos)
{
        if(*ppos >= MAX_SLAM_SIZE)
                return 0;

        if(*ppos + count > MAX_SLAM_SIZE)
                count = MAX_SLAM_SIZE - *ppos;

        if(copy_from_user(array + *ppos, buf, count))
                return -EFAULT;

        *ppos += count;

        return count;
}

static struct file_operations slam_array_fops =
{
        .owner = THIS_MODULE,
        .open = slam_open,
        .read = slam_read,
        .write = slam_write,
};

static int __init debugfs_example_init(void)
{
        slam_debug_dir = debugfs_create_dir("slam_debug", NULL);

        bw.data = (void *)array;
        bw.size = strlen(array) + 1;
        debugfs_create_blob("array", 0644, slam_debug_dir, &bw);

        slam_dir = debugfs_create_dir("slam", slam_debug_dir);
        debugfs_create_u8("u8", 0644, slam_debug_dir, &u8_var);
        debugfs_create_file("array", 0644, slam_dir, NULL, &slam_array_fops);

        return 0;
}

static void __exit debugfs_example_exit(void)
{
        debugfs_remove_recursive(slam_debug_dir);
}

module_init(debugfs_example_init);
module_exit(debugfs_example_exit);
相应的Makefile内容如下：
obj-m += debugfs_example.o

CUR_PATH:=$(shell pwd)
LINUX_KERNEL_PATH:=/home/xinu/linux-3.13.6

all:
        make -C $(LINUX_KERNEL_PATH) M=$(CUR_PATH) modules

clean:
        make -C $(LINUX_KERNEL_PATH) M=$(CUR_PATH) clean
相应的源码文件目录树如下：
/home/xinu/xinu/linux_kernel_driver_l1/debugfs_example/
├── debugfs_example.c
└── Makefile
编译加载KO后，在/sys/kernel/debug目录下就会生成相应的目录和文件节点，相关目录树在源码里有说明。至此，我们对Debugfs也进行了了解。
参考网址：
http://www.embeddedlinux.org.cn/html/yingjianqudong/201304/17-2553.html
http://www.cnblogs.com/wwang/archive/2011/01/17/1937609.html
https://www.ibm.com/developerworks/cn/linux/l-kerns-usrs2/

评论

发表评论

此博客中的热门博文

I/O映射之I/O端口

图片
对于外设，操作系统会采用端口映射和内存映射两种方式来对其进行控制，其中端口映射就是操作系统规定好一段地址给指定换上设，其与外设的寄存器按顺序一一对应上。 在Linux内核源码include/asm-generic/io.h头文件里有如下我们对I/O port进行操作的函数： static inline u8 inb(unsigned long addr) { return readb(addr + PCI_IOBASE); } static inline u16 inw(unsigned long addr) { return readw(addr + PCI_IOBASE); } static inline u32 inl(unsigned long addr) { return readl(addr + PCI_IOBASE); } static inline void outb(u8 b, unsigned long addr) { writeb(b, addr + PCI_IOBASE); } static inline void outw(u16 b, unsigned long addr) { writew(b, addr + PCI_IOBASE); } static inline void outl(u32 b, unsigned long addr) { writel(b, addr + PCI_IOBASE); } #define inb_p(addr) inb(addr) #define inw_p(addr) inw(addr) #define inl_p(addr) inl(addr) #define outb_p(x, addr) outb((x), (addr)) #define outw_p(x, addr) outw((x), (addr)) #define outl_p(x, addr) outl((x), (addr)) 分别对应对端口进行读取或写入字节、字、双字大小数据的操作。 该头文件中还有其他的操作函数及宏定义，请自行深入了解。 我们可通过读取/proc/ioports文件来了解Linux里I/O端口的映射
阅读全文

通过Netlink检测网线插拔

  最近有个需求需要检测RJ45网卡的网线有没有接上，而最近正在了解Netlink相关资料，刚好也看下通过Netlink可以进行检测，故在此做下粗略笔记：   1.首先要创建一个Netlink Socket，在用户层使用如下参数来调用socket()函数：    fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE);    上面这个函数第一个参数必须是AF_NETLINK或PF_NETLINK，这两个标志在Linux下是一样的，第二个参数可以是SOCK_RAW或SOCK_DGRAM（对应用到TCP或UDP协议），而最后一个参数NETLINK_ROUTE为“路由守护进程”，用于接收来自内核的路由通知事件。   2.将上面创建的Socket绑定    addr.nl_family = AF_NETLINK;    addr.nl_groups = RTNLGRP_LINK; //指定接收路由多播组消息    bind(fd, (struct sockaddr*)&addr, sizeof(addr));    上面将创建的socket与相应的协议族和组进行绑定，接下来通过读fd这个socket来获得相应的消息数据struct nlmsghdr，再对该结构体数据进行判断来获得网线是接上或是拔掉，相应的源码如下： #include <sys/types.h>  #include <sys/socket.h>  #include <asm/types.h>  #include <linux/netlink.h>  #include <linux/rtnetlink.h>  #include <stdlib.h>  #include <stdio.h>  #include <sys/ioctl.h>  #include <linux/if.h>  #include <string.h>  #define BUFLEN 20480  int main(int argc, char *argv[])  {      int fd, retval;      char buf[BUFLEN] = {0};
阅读全文

使用seq_file

在《使用procfs》一文的源码示例中有说到proc文件系统每次读取的数据只能是1个页，如果超过则需多次读取，这样的话会增加读取次数，增多系统调用次数，影响了整体的效率，故而才有seq file序列文件的出现，该项功能使得内核对于大文件的读取更加容易。 对于seq file，其结构体定义在include/linux/seq_file.h文件中，内容如下： struct seq_file { char *buf; size_t size; size_t from; size_t count; size_t pad_until; loff_t index; loff_t read_pos; u64 version; struct mutex lock; const struct seq_operations *op; int poll_event; #ifdef CONFIG_USER_NS struct user_namespace *user_ns; #endif void *private; }; 这里不详细说明该结构体，仅供感受下。 对于seq_file，相应的文件操作需要实现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); }; 实现该结构体成员后，需要使用seq_open打开，让文件与该seq_operations关联起来，最终这个open函数要作为file_oper
阅读全文