設備驅動之mmap函數

from: 

http://blog.csdn.net/mirkerson/article/details/8232422

http://blog.chinaunix.net/uid-25906157-id-1754499.html

http://blog.csdn.net/bg2bkk/article/details/8946562

1.mmap系統調用

void *mmap(void *addr, size_t len, int prot, int flags, int fd, off_t offset);

功能：負責把文件內容映射到進程的虛擬地址空間，通過對這段內存的讀取和修改來實現對文件的讀取和修改，而不需要再調用read和write；
參數：addr：映射的起始地址，設爲NULL由系統指定；
len：映射到內存的文件長度；
prot：期望的內存保護標誌，不能與文件的打開模式衝突。PROT_EXEC,PROT_READ,PROT_WRITE等；
flags：指定映射對象的類型，映射選項和映射頁是否可以共享。MAP_SHARED，MAP_PRIVATE等；
fd：由open返回的文件描述符，代表要映射的文件；
offset：開始映射的文件的偏移。
返回值：成功執行時，mmap()返回被映射區的指針。失敗時，mmap()返回MAP_FAILED。

mmap映射圖：

2.解除映射：
　int munmap(void *start, size_t length); 

3.虛擬內存區域：
虛擬內存區域是進程的虛擬地址空間中的一個同質區間，即具有同樣特性的連續地址範圍。一個進程的內存映象由下面幾個部分組成：程序代碼、數據、BSS和棧區域，以及內存映射的區域。
linux內核使用vm_area_struct結構來描述虛擬內存區。其主要成員：

unsigned long vm_start; /* Our start address within vm_mm. */
unsigned long vm_end; /* The first byte after our end address within vm_mm. */
unsigned long vm_flags; /* Flags, see mm.h. 該區域的標記。如VM_IO（該VMA標記爲內存映射的IO區域,會阻止系統將該區域包含在進程的存放轉存中）和VM_RESERVED（標誌內存區域不能被換出）。*/

4.mmap設備操作：
映射一個設備是指把用戶空間的一段地址（虛擬地址區間）關聯到設備內存上，當程序讀寫這段用戶空間的地址時，它實際上是在訪問設備。
mmap方法是file_operations結構的成員，在mmap系統調用的發出時被調用。在此之前，內核已經完成了很多工作。
mmap設備方法所需要做的就是建立虛擬地址到物理地址的頁表（虛擬地址和設備的物理地址的關聯通過頁表）。

static int mmap(struct file *file, struct vm_area_struct *vma)；

mmap如何完成頁表的建立？（兩種方法）
（1）使用remap_pfn_range一次建立所有頁表。

int remap_pfn_range(struct vm_area_struct *vma, unsigned long addr, unsigned long pfn, unsigned long size, pgprot_t prot)；
/**
* remap_pfn_range - remap kernel memory to userspace
* @vma: user vma to map to：內核找到的虛擬地址區間
* @addr: target user address to start at：要關聯的虛擬地址
* @pfn: physical address of kernel memory：要關聯的設備的物理地址，也即要映射的物理地址所在的物理幀號，可將物理地址>>PAGE_SHIFT
* @size: size of map area
* @prot: page protection flags for this mapping
*
* Note: this is only safe if the mm semaphore is held when called.
*/

（2）使用nopage VMA方法每次建立一個頁表；

 

5.源碼分析：

（1）memdev.h

#ifndef _MEMDEV_H_
#define _MEMDEV_H_
#ifndef MEMDEV_MAJOR
#define MEMDEV_MAJOR 452
/*預設的mem的主設備號*/
#endif
#ifndef MEMDEV_NR_DEVS
#define MEMDEV_NR_DEVS 2    /*設備數*/
#endif
#ifndef MEMDEV_SIZE
#define MEMDEV_SIZE 4096//分配內存的大小
#endif
/*mem設備描述結構體*/
struct mem_dev
{
  char *data; //分配到的內存的起始地址
  unsigned long size;  //內存的大小
};
#endif /* _MEMDEV_H_ */

（2）memdev.c

#include <linux/module.h>
#include <linux/types.h>
#include <linux/fs.h>
#include <linux/errno.h>
#include <linux/mm.h>
#include <linux/sched.h>
#include <linux/init.h>
#include <linux/cdev.h>
#include <asm/io.h>
//#include <asm/system.h>
#include <linux/slab.h>
#include <asm/uaccess.h>
#include "memdev.h"
static int mem_major = MEMDEV_MAJOR;
module_param(mem_major, int, S_IRUGO);
struct mem_dev *mem_devp; /*設備結構體指針*/
struct cdev cdev;
/*文件打開函數*/
int mem_open(struct inode *inode, struct file *filp)
{
    struct mem_dev *dev;

    /*獲取次設備號*/
    int num = MINOR(inode->i_rdev);// inode->i_rdev包含實際的設備編號
    if (num >= MEMDEV_NR_DEVS)
            return -ENODEV;
    dev = &mem_devp[num];

    /*將設備描述結構指針賦值給文件私有數據指針*/
    filp->private_data = dev;//使用這個成員來指向分配的數據

    return 0;
}
/*文件釋放函數*/
int mem_release(struct inode *inode, struct file *filp)
{
  return 0;
}
/*讀函數*/
static ssize_t mem_read(struct file *filp, char __user *buf, size_t size, loff_t *ppos)//buf緩存區，size讀取文件大小，ppos當前讀寫位置
{
  unsigned long p =  *ppos;//p爲當前讀寫位置
  unsigned int count = size;//一次讀取的大小
  int ret = 0;
  struct mem_dev *dev = filp->private_data; /*獲得設備結構體指針*/
  /*判斷讀位置是否有效*/
  if (p >= MEMDEV_SIZE)//是否超出讀取獲圍
    return 0;
  if (count > MEMDEV_SIZE - p)
    count = MEMDEV_SIZE - p;//count大於可讀取的範圍，則縮小讀取範圍。
  /*讀數據到用戶空間*/
  if (copy_to_user(buf, (void*)(dev->data + p), count))//返回buf,讀取位置，讀取數量
  {
    ret =  - EFAULT;
  }
  else
  {
    *ppos += count;//將文件當前位置向後移
    ret = count;//返回實際讀取字節數

    printk(KERN_INFO "read %d bytes(s) from %ld\n", count, p);
  }
  return ret;//返回實際讀取字節數，判斷讀取是否成功
}
/*寫函數*/
static ssize_t mem_write(struct file *filp, const char __user *buf, size_t size, loff_t *ppos)//write和read類似，直接參考read
{
  unsigned long p =  *ppos;
  unsigned int count = size;
  int ret = 0;
  struct mem_dev *dev = filp->private_data; /*獲得設備結構體指針*/

  /*分析和獲取有效的寫長度*/
  if (p >= MEMDEV_SIZE)
    return 0;
  if (count > MEMDEV_SIZE - p)
    count = MEMDEV_SIZE - p;

  /*從用戶空間寫入數據*/
  if (copy_from_user(dev->data + p, buf, count))
    ret =  - EFAULT;
  else
  {
    *ppos += count;
    ret = count;

    printk(KERN_INFO "written %d bytes(s) from %ld\n", count, p);
  }
  return ret;
}
/* seek文件定位函數 */
static loff_t mem_llseek(struct file *filp, loff_t offset, int whence)//作改變文件中的當前讀/寫位置, 並且新位置作爲(正的)返回值在測試程序中要重新定位文件位置，whence這裏被設置爲 SEEK_SET
{
    loff_t newpos;
    switch(whence) {
      case 0: /* SEEK_SET */
        newpos = offset;//從文件頭開始定位
        break;
      case 1: /* SEEK_CUR */
        newpos = filp->f_pos + offset;//從文件中間定位
        break;
      case 2: /* SEEK_END */
        newpos = MEMDEV_SIZE -1 + offset;//從文件尾開始定位，由於是從0開始，所以要減1
        break;
      default: /* can't happen */
        return -EINVAL;
    }
    if ((newpos<0) || (newpos>MEMDEV_SIZE))
     return -EINVAL;

    filp->f_pos = newpos;//返回當前文件位置
    return newpos;
}

static int memdev_mmap(struct file*filp, struct vm_area_struct *vma)
{
      struct mem_dev *dev = filp->private_data; /*獲得設備結構體指針*/

      vma->vm_flags |= VM_IO;
      vma->vm_flags |= (VM_DONTEXPAND | VM_DONTDUMP);


      if (remap_pfn_range(vma,vma->vm_start,virt_to_phys(dev->data)>>PAGE_SHIFT, vma->vm_end - vma->vm_start, vma->vm_page_prot))
          return  -EAGAIN;

      return 0;
}

/*文件操作結構體*/
static const struct file_operations mem_fops =
{
  .owner = THIS_MODULE,
  .llseek = mem_llseek,
  .read = mem_read,
  .write = mem_write,
  .open = mem_open,
  .release = mem_release,
  .mmap = memdev_mmap,
};
/*設備驅動模塊加載函數*/
static int memdev_init(void)  //初始化模塊
{
  int result;
  int i;
  dev_t devno = MKDEV(mem_major, 0);//MKDEV是將主設備號和次設備號轉換爲dev_t類型數據,參數mem_major在頭文件中預設爲254

  /* 靜態申請設備號*/
  if (mem_major)//memdev.h 中定義了爲254。所以本例爲靜態分配主設備號254
    result = register_chrdev_region(devno, 2, "memdev");//devno爲主設備號，共申請兩個連續的設備，設備名爲"memdev"
  else  /* 動態分配設備號 */
  {
    result = alloc_chrdev_region(&devno, 0, 2, "memdev");//&devno作爲一個輸出參數，次設備號從0開始分配，申請2個設備，設備名爲"memdev"
    mem_major = MAJOR(devno);//獲取動態分配到的主設備號。
  }

  if (result < 0)//result返回0時爲申請成功，反加負值爲申請失敗。
    return result;
  /*初始化cdev結構*/
  cdev_init(&cdev, &mem_fops);//初始化cdev結構，將結構體cdev和mem_fops綁定起來
  cdev.owner = THIS_MODULE;//驅動引用計數，作用是這個驅動正在使用的時候，你再次用inmod命令時，出現警告提示
  cdev.ops = &mem_fops;

  /* 註冊字符設備 */
  cdev_add(&cdev, MKDEV(mem_major, 0), MEMDEV_NR_DEVS);//MEMDEV_NR_DEVS=2，分配2個設備

  /* 爲設備描述結構分配內存*/
  mem_devp = kmalloc(MEMDEV_NR_DEVS * sizeof(struct mem_dev), GFP_KERNEL);//kmalloc函數返回的是虛擬地址(線性地址).
  if (!mem_devp)    /*申請失敗*/
  {
    result =  - ENOMEM;
    goto fail_malloc;
  }
  memset(mem_devp, 0, sizeof(struct mem_dev));//新申請的內存做初始化工作

  /*爲設備分配內存*/
  for (i=0; i < MEMDEV_NR_DEVS; i++)
  {
        mem_devp[i].size = MEMDEV_SIZE;//#define MEMDEV_SIZE 4096
        mem_devp[i].data = kmalloc(MEMDEV_SIZE, GFP_KERNEL);//分配內存給兩個設備
        memset(mem_devp[i].data, 0, MEMDEV_SIZE);//初始化新分配到的內存
  }

  return 0;
  fail_malloc:
  unregister_chrdev_region(devno, 1);//如果申請失敗，註銷設備

  return result;
}
/*模塊卸載函數*/
static void memdev_exit(void)
{
  cdev_del(&cdev);   /*註銷設備*/
  kfree(mem_devp);     /*釋放設備結構體內存*/
  unregister_chrdev_region(MKDEV(mem_major, 0), 2); /*釋放設備號*/
}
MODULE_AUTHOR("David Xie");
MODULE_LICENSE("GPL");
module_init(memdev_init);
module_exit(memdev_exit);

(3)test.c:

#include <stdio.h>
#include<sys/types.h>
#include<sys/stat.h>
#include<fcntl.h>
#include<unistd.h>
#include<sys/mman.h>

int main()
{
    int fd;
    char *start;
    //char buf[100];
    char *buf;

    /*打開文件*/
    fd = open("/dev/memdev0",O_RDWR);

    buf = (char *)malloc(100);
    memset(buf, 0, 100);
    start=mmap(NULL,100,PROT_READ|PROT_WRITE,MAP_SHARED,fd,0);

    /* 讀出數據 */
    strcpy(buf,start);
    sleep (1);
    printf("buf 1 = %s\n",buf);

    /* 寫入數據 */
    strcpy(start,"Buf Is Not Null!");

    memset(buf, 0, 100);
    strcpy(buf,start);
    sleep (1);
    printf("buf 2 = %s\n",buf);


    munmap(start,100); /*解除映射*/
    free(buf);
    close(fd);
    return 0;
}

測試步驟：

（1）編譯安裝內核模塊：insmod memdev.ko; 

（2）查看設備名、主設備號：cat /proc/devices

（3）手工創建設備節點：mknod /dev/memdev0 c 452 0; mknod /dev/memdev0 c 452 1

　　查看設備文件是否存在：ls -l /dev/* | grep memdev*

（4）編譯下載運行應用程序：sudo ./test 最好用超級用戶權限運行，否則有時會出現權限問題，有時不出現權限的提示；

　　結果：buf 1 = 

　　　　　buf 2 = Buf Is Not Null!

總結：

1. mmap設備方法實現將用戶空間的一段內存關聯到設備內存上，對用戶空間的讀寫就相當於對字符設備的讀寫；不是所有的設備都能進行mmap抽象，比如像串口和其他面向流的設備就不能做mmap抽象。

2. 設備號要確保唯一，不與當前系統中設備號衝突，否則會出現device busy的提示；

3. 用戶空間調用mmap函數，要確保驅動中實現了對應的mmap函數；

用c函數測試(此時要用sudo運行test，否則會提示Open Memdev0 Error!）

// test.c:

#include <stdio.h>

int main()
{
 FILE *fp0 = NULL;
 char Buf[4096];

 /*初始化Buf*/
 strcpy(Buf,"Mem is char dev!");
 printf("BUF: %s\n",Buf);

 /*打開設備文件*/
 fp0 = fopen("/dev/memdev0","r+");
 if (fp0 == NULL)
 {
  printf("Open Memdev0 Error!\n");
  return -1;
 }

 /*寫入設備*/
 fwrite(Buf, sizeof(Buf), 1, fp0);

 /*重新定位文件位置（思考沒有該指令，會有何後果)*/
 fseek(fp0,0,SEEK_SET);//調用mem_llseek（）定位

 /*清除Buf*/
 strcpy(Buf,"Buf is NULL!");
 printf("BUF: %s\n",Buf);


 /*讀出設備*/
 fread(Buf, sizeof(Buf), 1, fp0);

 /*檢測結果*/
 printf("BUF: %s\n",Buf);

 return 0;
}

用系統調用測試:

#include <sys/stat.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>

void main(void)
{
    int fd;
    int i;
    char data[256];
    int retval;
    fd = open("/dev/memdev1",O_RDWR);
    if(fd==-1)
    {
        perror("erroropen\n");
        exit(-1);
    }
    printf("open/dev/memdev1 successfully\n");
    //寫數據
    retval = write(fd,"test",4);
    if(retval==-1)
    {
        perror("write error\n");
        exit(-1);
    }
    printf("write successfully\n");
    //讀數據
    lseek( fd, 0, SEEK_SET );
    retval=read(fd,data,4);
    if(retval==-1)
    {
        perror("read error\n");
        exit(-1);
    }
    data[retval]=0;
    printf("read successfully:%s\n",data);
    //關閉設備
    close(fd);