35.美学原理Linux-分析并制作环形缓冲区

在上章34.Linux-printk分析、使用printk调试驱动里描述了:

     printk()会将打印新闻存在根本的环形缓冲区log_buf[]里, 可以透过dmesg命令来查看log_buf[]

 

 


1.环形缓冲区log_buf[]又是存在根本的哪位文件呢?

置身/proc/kmsg里,所以除了dmesg命令查看,也得以应用cat /proc/kmsg来查阅

 

2.只是,dmesg命令和cat /proc/kmsg有所不一致

2.1
dmesg命令

老是使用,都会打印出环形缓冲区的具备音讯

2.2
cat /proc/kmsg

只会打印出每一回新的环形缓冲区的新闻

比如说,第一遍接纳cat
/proc/kmsg,会打印出基础启动的拥有新闻

第二次选取cat
/proc/kmsg,就不会并发此前打印的音讯,只打印继上次应用cat
/proc/kmsg之后的新的信息,比如下图所示:

 美学原理 1

 

3.接下来大家便进入基础,找/proc/kmsg文件在哪生成的

搜索”kmsg”,找到位于fs\proc\proc_misc.c
文件的proc_misc_init()函数中,

该函数首要用来生成登记的装置文件,具体代码如下所示:

const struct file_operations proc_kmsg_operations = {
       .read              = kmsg_read,               //读函数
       .poll        = kmsg_poll,
       .open             = kmsg_open,
       .release   = kmsg_release,
};


void __init proc_misc_init(void)
{
  ... ...
  struct proc_dir_entry *entry;                                   // 用来描述文件的结构体,
         entry = create_proc_entry("kmsg", S_IRUSR, &proc_root); //使用create_proc_entry()创建文件
if (entry)
         entry->proc_fops = &proc_kmsg_operations;    //对创建的文件赋入file_ operations
    ... ...
}

从上边代码得出,/proc/kmsg文件,也是有file_operations结构体的,而cat命令就会一向读/proc/kmsg的file_operations->read(),实现读log_buf[]的数据

且/proc/kmsg文件是经过create_proc_entry()创造出来的,参数如下所示:

“kmsg”:文件名

&proc_root:父目录,表示存在/proc根目录下

S_IRUSR: 等于400,表示拥有者(usr)可读,其余任什么人无法开展任何操作,如下图所示:

 美学原理 2

该参数和chmod命令参数一样,除了S_IRUSR还有很多参数,比如:

S_IRWXU: 等于700, 表示拥有者(usr)可读(r)可写(w)可实施(x)

S_IRWXG: 等于070, 表示拥有者和组用户 (group)可读(r)可写(w)可进行(x)

 

4.为啥选用dmesg命令和cat
/proc/kmsg会有那样大的界别?

大家进入proc_kmsg_operations-> kmsg_read()看看,就知道了

static ssize_t kmsg_read(struct file *file, char __user *buf,size_t count, loff_t *ppos)
{
       /*若在非阻塞访问,且没有读的数据,则立刻return*/
       if ((file->f_flags & O_NONBLOCK) && !do_syslog(9, NULL, 0))
              return -EAGAIN;
       return do_syslog(2, buf, count);          //开始读数据,buf:用户层地址,count:要读的数据长度
}

5.proc_kmsg_operations->
kmsg_read()->**
do_syslog(9, NULL,
0)**的内容如下所示:

 美学原理 3

其中log_start和log_end就是环形缓冲区的三个标志,
log_start也得以称为读标志位,
log_end也可以称为写标志位,当写标志和读标志一致时,则代表并未读的数量了。

6.proc_kmsg_operations->
kmsg_read()->**
do_syslog(2, buf,
count)**的情节如下所示:

case 2:           /* Read from log */
              error = -EINVAL;
              if (!buf || len < 0)           //判断用户层是否为空,以及读数据长度
                     goto out;
              error = 0;
              if (!len)
                     goto out;
              if (!access_ok(VERIFY_WRITE, buf, len)) {      // access_ok:检查用户层地址是否访问OK
                     error = -EFAULT;
                     goto out;
              }

              /*若没有读的数据,则进入等待队列*/
              error = wait_event_interruptible(log_wait, (log_start - log_end));
              if (error)
                    goto out;

              i = 0;
              spin_lock_irq(&logbuf_lock);        
              while (!error && (log_start != log_end) && i < len) {
                     c = LOG_BUF(log_start);         // LOG_BUF:取环形缓冲区log_buf[]里的某个位置的数据
                     log_start++;                        //读地址++
                     spin_unlock_irq(&logbuf_lock);
                     error = __put_user(c,buf);            //和 copy_to_user()函数一样,都是上传用户数据
                     buf++;                                       //用户地址++
                     i++;                                        //读数据长度++
                     cond_resched();
                     spin_lock_irq(&logbuf_lock);
              }
              spin_unlock_irq(&logbuf_lock);
              if (!error)
                     error = i;
              break;}
out:
       return error;
}

大庭广众就是对环形缓冲区的读操作,而环形缓冲区的法则又是哪些?

7.接下来便来分析环形缓冲区的规律

和位置函数一样, 环形缓冲区须要一个大局数组,还要求三个标志:读标志R、写标志W

大家以一个大局数组my_buff[7]为例,来分析:

7.1环形缓冲区开首时:

int R=0;             //记录读的位置
int W=0;             //记录写的位置    

上边的代码,如下图1所示:

 美学原理 4

 

R:从数组[R]开首读数据

W:从数组[W]开班写多少

所以,当R==W时,则意味着从未数量可读,通过那一个逻辑便能写出读数据了

7.2当大家要求读数据时:

int read_buff(char  *p)              //p:指向要读出的地址
{
if(R==W)            
      return 0;       //读失败
*p=my_buff[R];
R=(R+1)%7;      //R++    
return  1;         //读成功  
}

我们以W=3,R=0,为例,调用3次read_buff()**函数,**如下图所示:

 美学原理 5

 

读数据落成,剩下就是写多少了,很鲜明每写一个数目,W则++

7.3所以写多少函数为:

void write_buff(char c)              //c:等于要写入的内容
{
  my_buff [W]=c;         
  W=(W+1)%7;    //W++          
if(W==R)
  R=(R+1)%7;      //R++
}

7.3.1
下面的代码,为啥要认清if((W==R)?

比如,当我们写入一个8个数据,而my_buff[]只能存7个数据,必定会有W==R的时候,如果不加该论断,效益图如下所示:

 美学原理 6

 

然后大家再频仍调用read_buff(),就会意识只读的出第8个数据的值,而眼前7个数据都会被屏弃掉

7.3.2而投入判断后,功效图如下所示:

 美学原理 7

 

接下来大家再反复调用read_buff(),就可以读出my_buff [2]~ my_buff
[0]共6个数据出来

总结:

由于read_buff()后,R都会+1,所以每便 cat /proc/kmsg ,
都会清空上次的打印新闻。

 

8.环形缓冲区分析完结后,大家就可以直接来写一个使得,模仿/proc/kmsg文件来看望

流程如下:

  • 1)概念全局数组my_buff[1000]环形缓冲区,R标志,W声明,然后提供写函数,读函数
  • 2)自制一个myprintk(),通过传播的数据来放入到my_buff[]环形缓冲区中
  • (PS:必要通过EXPORT_SYMBOL(myprintk)注解该myprintk,否则无法被其余驱动程序调用
    )
  • 3)写入口函数
  •    ->3.1) 通过create_proc_entry()创建/proc/mykmsg文件
  •  
     ->3.2
     )并向mykmsg文件里添加file_operations结构体
  • 4)写出口函数
  •  
     ->4.1)
    通过remove_proc_entry()卸载/proc/mykmsg文件
  • 5)file_operations->read()函数
  •    ->5.1) 仿照/proc/kmsg的read()函数,来读my_buff[]环形缓冲区的数额

切切实实代码如下所示:

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/fs.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <asm/uaccess.h>
#include <asm/irq.h>
#include <asm/io.h>
#include <asm/arch/regs-gpio.h>
#include <asm/hardware.h>
#include <linux/proc_fs.h>

#define my_buff_len   1000          //环形缓冲区长度

static struct proc_dir_entry *my_entry;


/*    声明等待队列类型中断 mybuff_wait      */
static DECLARE_WAIT_QUEUE_HEAD(mybuff_wait);


static char my_buff[my_buff_len]; 
unsigned long R=0;                      //记录读的位置
unsigned long W=0;                    //记录写的位置

int read_buff(char  *p)         //p:指向要读出的地址
{
   if(R==W)          
             return 0;               //读失败
        *p=my_buff[R]; 
         R=(R+1)%my_buff_len;       //R++
        return  1;                   //读成功   
}

void write_buff(char c)          //c:等于要写入的内容
{    
        my_buff [W]=c;       
        W=(W+1)%my_buff_len;     //W++
        if(W==R)
            R=(R+1)%my_buff_len;     //R++
       wake_up_interruptible(&mybuff_wait);     //唤醒队列,因为R != W 
}

/*打印到my_buff[]环形缓冲区中*/
int myprintk(const char *fmt, ...)
{
       va_list args;
       int i,len;
       static char temporary_buff[my_buff_len];        //临时缓冲区
       va_start(args, fmt);
       len=vsnprintf(temporary_buff, INT_MAX, fmt, args);
       va_end(args);

        /*将临时缓冲区放入环形缓冲区中*/
       for(i=0;i<len;i++)       
       {
            write_buff(temporary_buff[i]);
       }
       return len;
}

static int mykmsg_open(struct inode *inode, struct file *file)
{
        return 0;
}  

static int mykmsg_read(struct file *file, char __user *buf,size_t count, loff_t *ppos)
{
      int error = 0,i=0;
      char c;

        if((file->f_flags&O_NONBLOCK)&&(R==W))      //非阻塞情况下,且没有数据可读
            return  -EAGAIN;

       error = -EINVAL;

              if (!buf || !count )
                     goto out;

       error = wait_event_interruptible(mybuff_wait,(W!=R));
              if (error)
                     goto out;

       while (!error && (read_buff(&c)) && i < count) 
      {
        error = __put_user(c,buf);      //上传用户数据
        buf ++;
        i++;
      }

      if (!error)
               error = i;
out:
       return error;
}  

const struct file_operations mykmsg_ops = {
       .read              = mykmsg_read,
       .open         = mykmsg_open,
};
static int  mykmsg_init(void)
{
    my_entry = create_proc_entry("mykmsg", S_IRUSR, &proc_root);
   if (my_entry)
         my_entry->proc_fops = &mykmsg_ops;
    return 0;
}
static void mykmsg_exit(void)
{
        remove_proc_entry("mykmsg", &proc_root);  
}

module_init(mykmsg_init);
module_exit(mykmsg_exit); 
EXPORT_SYMBOL(myprintk);
MODULE_LICENSE("GPL");

 

PS:当其余驱动向利用myprintk()打印函数,还亟需在文件中扬言,才行:

extern int myprintk(const char *fmt, ...);

且还亟需先装载mykmsg驱动,再来装载要使用myprintk()的驱动,否则不能找到myprintk()函数

 

9.测试运行

一般来说图所示,挂载了mykmsg驱动,可以见到变化了一个/proc/mykmsg文件

 美学原理 8

挂载/proc/mykmsg时期,其他驱动使用myprintk()函数,就会将新闻打印在/proc/mykmsg文件中,如下图所示:

  美学原理 9

和cat /proc/kmsg一样,每一遍cat
都会清上两回的打印数据

10.若我们不想每一趟清,和dmesg命令一样,
老是都能打印出环形缓冲区的富有信息,该怎么改mykmsg驱动?

上次大家分析过了,每一次调用read_buff()后,R都会+1。

要想不清空上次的音信打印,还亟需定义一个R_ current标志来代替R标志,那样每一回cat截止后,R的岗位保持不变。

每回cat时,系统除了进入file_operations->
read(),还会进去file_operations-> open(),所以在open()里,使R_
current=R,然后在修改部分代码即可,

10.1我们仍然以一个大局数组my_buff[7]为例,
正如图所示:

美学原理 10

10.2就此,修改的代码如下所示:

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/fs.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <asm/uaccess.h>
#include <asm/irq.h>
#include <asm/io.h>
#include <asm/arch/regs-gpio.h>
#include <asm/hardware.h>
#include <linux/proc_fs.h>

#define my_buff_len   1000          //环形缓冲区长度

static struct proc_dir_entry *my_entry;

/*    声明等待队列类型中断 mybuff_wait      */
static DECLARE_WAIT_QUEUE_HEAD(mybuff_wait);

static char my_buff[my_buff_len];

unsigned long R=0;                      //记录读的位置
unsigned long R_current=0;             //记录cat期间 读的位置
unsigned long W=0;                    //记录写的位置

int read_buff(char  *p)         //p:指向要读出的地址
{
        if(R_current==W)             
             return 0;               //读失败
        *p=my_buff[R_current]; 
         R_current=(R_current+1)%my_buff_len;     //R_current++
        return  1;                   //读成功   
}

void write_buff(char c)          //c:等于要写入的内容
{    
        my_buff [W]=c;       
        W=(W+1)%my_buff_len;     //W++
        if(W==R)
          R=(R+1)%my_buff_len;     //R++
        if(W==R_current)
          R=(R+1)%my_buff_len;     //R_current++
       wake_up_interruptible(&mybuff_wait);     //唤醒队列,因为R !=W 
}

/*打印到my_buff[]环形缓冲区中*/
int myprintk(const char *fmt, ...)
{
  va_list args;
  int i,len;
  static char temporary_buff[my_buff_len];        //临时缓冲区
  va_start(args, fmt);
  len=vsnprintf(temporary_buff, INT_MAX, fmt, args);
  va_end(args);
     /*将临时缓冲区放入环形缓冲区中*/
       for(i=0;i<len;i++)       
       {
            write_buff(temporary_buff[i]);
       }
  return len;
}

static int mykmsg_open(struct inode *inode, struct file *file)
{
        R_current=R;       
        return 0;
}  

static int mykmsg_read(struct file *file, char __user *buf,size_t count, loff_t *ppos)
{
      int error = 0,i=0;
      char c;     
        if((file->f_flags&O_NONBLOCK)&&(R_current==W))      //非阻塞情况下,且没有数据可读
            return  -EAGAIN;
        error = -EINVAL;
       if (!buf || !count )
              goto out;

       error = wait_event_interruptible(mybuff_wait,(W!=R_current));
       if (error)
              goto out;

      while (!error && (read_buff(&c)) && i < count) 
      {
        error = __put_user(c,buf);      //上传用户数据
        buf ++;
        i++;
      }

      if (!error)
        error = i;

out:
  return error;
}  

const struct file_operations mykmsg_ops = {
  .read         = mykmsg_read,
  .open         = mykmsg_open,

};

static int  mykmsg_init(void)
{
    my_entry = create_proc_entry("mykmsg", S_IRUSR, &proc_root);
   if (my_entry)
    my_entry->proc_fops = &mykmsg_ops;
    return 0;
}
static void mykmsg_exit(void)
{
   remove_proc_entry("mykmsg", &proc_root);
}

module_init(mykmsg_init);
module_exit(mykmsg_exit); 
EXPORT_SYMBOL(myprintk); 
MODULE_LICENSE("GPL"); 

 

11.测试运行

 美学原理 11