七、设备驱动中的阻塞与非阻塞 IO（二）

7.2 轮询

7.2.1 介绍

　　在用户程序中的 select() 和 poll() 函数最终会使设备驱动中的 poll() 函数被执行。

　　设备驱动程序中的轮询函数原型：

   /** 用于询问设备是否可以非阻塞的读写。当询问条件未触发时，用户空间进行 select() 和 poll() 将引起进程阻塞 */
     unsigned int (*poll) (struct file *filp, struct poll_table_struct *wait);

• wait：轮询表指针。
• 这个函数应该进行两项工作：
  • 对可能引起设备文件状态变化的等待队列调用 poll_wait() 函数，将对应的等待队列头部添加到 poll_table 中
  • 返回表示是否能对设备进行无阻塞读、写访问的掩码

　　

7.2.2 globalfifo 支持轮询

globalfifo.c

 #include <linux/module.h>
 #include <linux/fs.h>
 #include <linux/init.h>
 #include <linux/cdev.h>
 #include <linux/slab.h>
 #include <linux/uaccess.h>
 #include <linux/mutex.h>
 #include <linux/wait.h>
 #include <linux/sched/signal.h> ///< 内核>5.0 使用
 //#include <linux/sched.h>
 #include <linux/poll.h>

 #define GLOBALFIFO_SIZE      0x1000
 #define MEM_CLEAR           0X1
 //#define GLOBALFIFO_MAGIC     'g'
 //#define MEM_CLEAR           _IO(GLOBALFIFO_MAGIC, 0)
 #define GLOBALFIFO_MAJOR    230
 #define DEVICE_NUMBER       10

 static int globalfifo_major = GLOBALFIFO_MAJOR;
 module_param(globalfifo_major, int, S_IRUGO);

 struct globalfifo_dev {
     struct cdev cdev;
     /**
      *  目前 FIFO 中有效数据长度
      *  current_len = 0, 表示 FIFO 为空
      *  current_len = GLOBALFIFO_SIZE, 表示 FIFO 满
      */
     unsigned int current_len;
     unsigned char mem[GLOBALFIFO_SIZE];
     struct mutex mutex;
     wait_queue_head_t r_wait;   ///< 读等待队列头
     wait_queue_head_t w_wait;   ///< 写等待队列头
 };

 struct globalfifo_dev *globalfifo_devp;

 /**
  * 这里涉及到私有数据的定义，大多数遵循将文件私有数据 pirvate_data 指向设备结构体，
  * 再用 read write llseek ioctl 等函数通过 private_data 访问设备结构体。
  * 对于此驱动而言，私有数据的设置是在 open 函数中完成的
  */
 static int globalfifo_open(struct inode *inode, struct file *filp)
 {
     /**
      *  NOTA:
      *      container_of 的作用是通过结构体成员的指针找到对应结构体的指针。
      *      第一个参数是结构体成员的指针
      *      第二个参数是整个结构体的类型
      *      第三个参数为传入的第一个参数(即结构体成员)的类型
      *      container_of 返回值为整个结构体指针
      */
     struct globalfifo_dev *dev = container_of(inode->i_cdev, struct globalfifo_dev, cdev);
     filp->private_data = dev;
     return ;
 }

 static int globalfifo_release(struct inode *inode, struct file *filp)
 {
     return ;
 }

 static long globalfifo_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
 {
     struct globalfifo_dev *dev = filp->private_data;

     switch(cmd){
     case MEM_CLEAR:
         mutex_lock(&dev->mutex);
         memset(dev->mem, , GLOBALFIFO_SIZE);
         printk(KERN_INFO "globalfifo is set to zero\n");
         mutex_unlock(&dev->mutex);
         break;
     default:
         return -EINVAL;
     }

     return ;
 }

 static unsigned int globalfifo_poll(struct file *filp, struct poll_table_struct *wait)
 {
     unsigned int mask = ;
     struct globalfifo_dev *dev = filp->private_data;

     mutex_lock(&dev->mutex);

     poll_wait(filp, &dev->r_wait, wait);
     poll_wait(filp, &dev->w_wait, wait);

     if(dev->current_len != ) {
         mask |= POLLIN | POLLRDNORM;
     }

     if(dev->current_len != GLOBALFIFO_SIZE){
         mask |= POLLIN | POLLWRNORM;
     }

     mutex_unlock(&dev->mutex);
     return mask;
 }

 static loff_t globalfifo_llseek(struct file *filp, loff_t offset, int orig)
 {
     loff_t ret = ;
     switch(orig) {
     case : /** 从文件开头位置 seek */
         if(offset < ){
             ret = -EINVAL;
             break;
         }
         if((unsigned int)offset > GLOBALFIFO_SIZE){
             ret = -EINVAL;
             break;
         }
         filp->f_pos = (unsigned int)offset;
         ret = filp->f_pos;
         break;
     case : /** 从文件当前位置开始 seek */
         if((filp->f_pos + offset) > GLOBALFIFO_SIZE){
             ret = -EINVAL;
             break;
         }
         if((filp->f_pos + offset) < ){
             ret = -EINVAL;
             break;
         }
         filp->f_pos += offset;
         ret = filp->f_pos;
         break;
     default:
         ret = -EINVAL;
         break;
     }

     return ret;
 }

 static ssize_t globalfifo_write(struct file *filp, const char __user *buf, size_t size, loff_t *ppos)
 {
     unsigned int count = size;
     int ret = ;
     struct globalfifo_dev *dev = filp->private_data;

     DECLARE_WAITQUEUE(wait, current);   ///< 将当前进程加入到 wait 等待队列
     mutex_lock(&dev->mutex);
     add_wait_queue(&dev->w_wait, &wait);   ///< 添加等待队列元到读队列头中

     /** 判断设备是否可写 */
     while(dev->current_len == GLOBALFIFO_SIZE){
         /** 若是非阻塞访问, 设备忙时, 直接返回 -EAGAIN */
         if(filp->f_flags & O_NONBLOCK) {
             ret = -EAGAIN;
             goto out;
         }

         __set_current_state(TASK_INTERRUPTIBLE);    ///<改变进程状态为睡眠
         schedule();
         if(signal_pending(current)){    ///< 因为信号而唤醒
             ret = -ERESTARTSYS;
             goto out2;
         }
     }

     if(count > GLOBALFIFO_SIZE - dev->current_len)
         count = GLOBALFIFO_SIZE - dev->current_len;

     if(copy_from_user(dev->mem + dev->current_len, buf, count)){
         ret = -EFAULT;
         goto out;
     } else {
         dev->current_len += count;
         printk(KERN_INFO "written %u bytes(s), current len:%d\n", count, dev->current_len);

         wake_up_interruptible(&dev->r_wait);    ///< 唤醒读等待队列
         ret = count;
     }
 out:
     mutex_unlock(&dev->mutex);
 out2:
     remove_wait_queue(&dev->w_wait, &wait); ///< 移除等待队列
     set_current_state(TASK_RUNNING);
     return ret;
 }

 /**
  * *ppos 是要读的位置相对于文件开头的偏移，如果该偏移大于或等于 GLOBALFIFO_SIZE，意味着已经独到文件末尾
  */
 static ssize_t globalfifo_read(struct file *filp, char __user *buf, size_t size, loff_t *ppos)
 {
     unsigned int count = size;
     int ret = ;
     struct globalfifo_dev *dev = filp->private_data;

     DECLARE_WAITQUEUE(wait, current);   ///< 将当前进程加入到 wait 等待队列
     mutex_lock(&dev->mutex);
     add_wait_queue(&dev->r_wait, &wait);   ///< 添加等待队列元到读队列头中

     /** 等待 FIFO 非空，即判断设备是否可读 */
     while(dev->current_len == ) {
         /** 若是非阻塞访问, 设备忙时, 直接返回 -EAGAIN */
         /** filp->f_flags 是用户空间 */
         if(filp->f_flags & O_NONBLOCK) {
             ret = -EAGAIN;
             goto out;
         }

         /**
          *  阻塞访问，调度其他进程执行
          *  FIFO 为空的情况下，读进程阻塞，必须依赖写进程往 FIFO 里面写东西唤醒它；
          *  但写的进程为了 FIFO，它必须拿到这个互斥体来访问 FIFO 这个临界资源；
          *  如果读进程把自己调度出去之前不释放这个互斥体，那么读写进程之间就死锁了
          */
         __set_current_state(TASK_INTERRUPTIBLE);    ///<改变进程状态为睡眠
         mutex_unlock(&dev->mutex);
         schedule();
         if(signal_pending(current)){    ///< 因为信号而唤醒
             ret = -ERESTARTSYS;
             goto out2;
         }

         mutex_lock(&dev->mutex);
     }

     /** 要读取的字节数大于设备文件中的有效数据长度 */
     if(count > dev->current_len)
         count = dev->current_len;

     /** 从用户空间拷贝数据 */
     if(copy_to_user(buf, dev->mem, count)) {
         ret = -EFAULT;
         goto out;
     } else {
         /** FIFO 中数据前移 */
         memcpy(dev->mem, dev->mem + count, dev->current_len - count);
         dev->current_len -= count;  ///< 有效数据长度减少
         printk(KERN_INFO "read %u bytes(s), current_len: %d\n", count, dev->current_len);

         wake_up_interruptible(&dev->w_wait);    ///< 唤醒写等待队列

         ret = count;
     }
 out:
     mutex_unlock(&dev->mutex);
 out2:
     remove_wait_queue(&dev->r_wait, &wait); ///< 移除等待队列
     set_current_state(TASK_RUNNING);
     return ret;
 }

 static const struct file_operations globalfifo_fops = {
     .owner = THIS_MODULE,
     .poll = globalfifo_poll,
     .llseek = globalfifo_llseek,
     .read = globalfifo_read,
     .write = globalfifo_write,
     .unlocked_ioctl = globalfifo_ioctl,
     .open = globalfifo_open,
     .release = globalfifo_release,
 };

 /**
  * @brief  globalfifo_setup_cdev
  *
  * @param  dev
  * @param  index    次设备号
  */
 static void globalfifo_setup_cdev(struct globalfifo_dev *dev, int index)
 {
     int err;
     int devno = MKDEV(globalfifo_major, index);

     /** 使用 cdev_init 即是静态初始化了 cdev */
     cdev_init(&dev->cdev, &globalfifo_fops);
     dev->cdev.owner = THIS_MODULE;

     /** 设备编号范围设置为1，表示我们只申请了一个设备 */
     err = cdev_add(&dev->cdev, devno, );
     if(err)
         printk(KERN_NOTICE "Error %d adding globalfifo%d\n", err, index);
 }

 static int __init globalfifo_init(void)
 {
     int ret;
     int i;
     dev_t devno = MKDEV(globalfifo_major, );

     if(globalfifo_major)
         ret = register_chrdev_region(devno, DEVICE_NUMBER, "globalfifo");
     else {
         ret = alloc_chrdev_region(&devno, , DEVICE_NUMBER, "globalfifo");
         globalfifo_major = MAJOR(devno);
     }

     if(ret < )
         return ret;

     globalfifo_devp = kzalloc(sizeof(struct globalfifo_dev), GFP_KERNEL);
     if(!globalfifo_devp){
         ret = -ENOMEM;
         goto fail_malloc;
     }

     for(i = ; i < DEVICE_NUMBER; i++){
         globalfifo_setup_cdev(globalfifo_devp + i, i);
     }

     mutex_init(&globalfifo_devp->mutex);

     /** 初始化读写等待队列 */
     init_waitqueue_head(&globalfifo_devp->r_wait);
     init_waitqueue_head(&globalfifo_devp->w_wait);

 fail_malloc:
     unregister_chrdev_region(devno, );
     return ret;
 }

 static void __exit globalfifo_exit(void)
 {
     int i;
     for(i = ; i < DEVICE_NUMBER; i++) {
         cdev_del(&(globalfifo_devp + i)->cdev);
     }
     kfree(globalfifo_devp);
     unregister_chrdev_region(MKDEV(globalfifo_major, ), DEVICE_NUMBER);
 }

 module_init(globalfifo_init);
 module_exit(globalfifo_exit);

epoll_test.c

     }

     epfd = epoll_create();
     if(epfd < ) {
         perror("epoll_create()");
         return ;
     }

     bzero(&ev_globalfifo, sizeof(struct epoll_event));
     ev_globalfifo.events = EPOLLIN | EPOLLPRI;
     err = epoll_ctl(epfd, EPOLL_CTL_ADD, fd, &ev_globalfifo);
     if(err < ) {
         perror("epoll_ctl()");
         return ;
     }
     err = epoll_wait(epfd, &ev_globalfifo, , );
     if(err < ) {
         perror("epoll_wait()");
     } else if(err == ) {
         printf("No data input in FIFO within 15 seconds.\n");
     } else {
         printf("FIFO is not empty.\n");
     }

     err = epoll_ctl(epfd, EPOLL_CTL_DEL, fd, &ev_globalfifo);
     if(err < ) {
         perror("epoll_ctl()");
         return ;
     }

     return;

 }

Makefile

 .PHONY:all clean test

 TEST_SRC := poll_test.c
 TEST_TARGET := poll_test

 ifneq ($(KERNELRELEASE),)

 obj-m := globalfifo.o

 else
 LINUX_KERNEL := $(shell uname -r)
 LINUX_KERNEL_PATH := /usr/src/linux-headers-$(LINUX_KERNEL)
 CURRENT_PATH  := $(shell pwd)
 EXTRA_CFLAGS += -DDEBUG

 all:
     make -C $(LINUX_KERNEL_PATH) M=$(CURRENT_PATH) modules
 clean:
     rm -fr *.ko *.o *.mod.o *.mod.c *.symvers *.order .*.ko *.cmd .tmp_versions $(TEST_TARGET)

 test:
     gcc -o $(TEST_TARGET) $(TEST_SRC)
 endif