Linux 字元裝置驅動結構(四)—— file_operations 結構體知識解析
前面在 Linux 字元裝置驅動開發基礎 (三)—— 字元裝置驅動結構(中) ,我們已經介紹了兩種重要的資料結構 struct inode{...}與 struct file{...} ,下面來介紹另一個比較重要資料結構
struct _file_operations
struct _file_operations在Fs.h這個檔案裡面被定義的,如下所示:
struct file_operations { struct module *owner;//擁有該結構的模組的指標,一般為THIS_MODULES loff_t (*llseek) (struct file *, loff_t, int);//用來修改檔案當前的讀寫位置 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);//從裝置中同步讀取資料 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);//向裝置傳送資料 ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t);//初始化一個非同步的讀取操作 ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t);//初始化一個非同步的寫入操作 int (*readdir) (struct file *, void *, filldir_t);//僅用於讀取目錄,對於裝置檔案,該欄位為NULL unsigned int (*poll) (struct file *, struct poll_table_struct *); //輪詢函式,判斷目前是否可以進行非阻塞的讀寫或寫入 int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long); //執行裝置I/O控制命令 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long); //不使用BLK檔案系統,將使用此種函式指標代替ioctl long (*compat_ioctl) (struct file *, unsigned int, unsigned long); //在64位系統上,32位的ioctl呼叫將使用此函式指標代替 int (*mmap) (struct file *, struct vm_area_struct *); //用於請求將裝置記憶體對映到程序地址空間 int (*open) (struct inode *, struct file *); //開啟 int (*flush) (struct file *, fl_owner_t id); int (*release) (struct inode *, struct file *); //關閉 int (*fsync) (struct file *, struct dentry *, int datasync); //重新整理待處理的資料 int (*aio_fsync) (struct kiocb *, int datasync); //非同步重新整理待處理的資料 int (*fasync) (int, struct file *, int); //通知裝置FASYNC標誌發生變化 int (*lock) (struct file *, int, struct file_lock *); ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int); unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long); int (*check_flags)(int); int (*flock) (struct file *, int, struct file_lock *); ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int); ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int); int (*setlease)(struct file *, long, struct file_lock **); };
Linux使用file_operations結構訪問驅動程式的函式,這個結構的每一個成員的名字都對應著一個呼叫。
使用者程序利用在對裝置檔案進行諸如read/write操作的時候,系統呼叫通過裝置檔案的主裝置號找到相應的裝置驅動程式,然後讀取這個資料結構相應的函式指標,接著把控制權交給該函式,這是Linux的裝置驅動程式工作的基本原理。
下面是各成員解析:
1、struct module *owner
第一個 file_operations 成員根本不是一個操作,它是一個指向擁有這個結構的模組的指標。
這個成員用來在它的操作還在被使用時阻止模組被解除安裝
2、loff_t (*llseek) (struct file * filp , loff_t p, int orig);
(指標引數filp為進行讀取資訊的目標檔案結構體指標;引數 p 為檔案定位的目標偏移量;引數orig為對檔案定位的起始地址,這個值可以為檔案開頭(SEEK_SET,0,當前位置(SEEK_CUR,1),檔案末尾(SEEK_END,2))
llseek 方法用作改變檔案中的當前讀/寫位置, 並且新位置作為(正的)返回值
loff_t 引數是一個"long offset", 並且就算在 32位平臺上也至少 64 位寬. 錯誤由一個負返回值指示;如果這個函式指標是 NULL, seek 呼叫會以潛在地無法預知的方式修改 file 結構中的位置計數器( 在"file 結構" 一節中描述).
3、ssize_t (*read) (struct file * filp, char __user * buffer, size_t size , loff_t * p);
(指標引數 filp 為進行讀取資訊的目標檔案,指標引數buffer 為對應放置資訊的緩衝區(即使用者空間記憶體地址),引數size為要讀取的資訊長度,引數 p 為讀的位置相對於檔案開頭的偏移,在讀取資訊後,這個指標一般都會移動,移動的值為要讀取資訊的長度值)
這個函式用來從裝置中獲取資料。在這個位置的一個空指標導致 read 系統呼叫以 -EINVAL("Invalid argument") 失敗。一個非負返回值代表了成功讀取的位元組數( 返回值是一個 "signed size" 型別, 常常是目標平臺本地的整數型別).
4、ssize_t (*aio_read)(struct kiocb * , char __user * buffer, size_t size , loff_t p);
可以看出,這個函式的第一、三個引數和本結構體中的read()函式的第一、三個引數是不同 的,非同步讀寫的第三個引數直接傳遞值,而同步讀寫的第三個引數傳遞的是指標,因為AIO從來不需要改變檔案的位置。非同步讀寫的第一個引數為指向kiocb結構體的指標,而同步讀寫的第一引數為指向file結構體的指標,每一個I/O請求都對應一個kiocb結構體);初始化一個非同步讀 -- 可能在函式返回前不結束的讀操作.如果這個方法是 NULL, 所有的操作會由 read 代替進行(同步地).(有關linux非同步I/O,可以參考有關的資料,《linux裝置驅動開發詳解》中給出了詳細的解答)
5、ssize_t (*write) (struct file * filp, const char __user * buffer, size_t count, loff_t * ppos);
(引數filp為目標檔案結構體指標,buffer為要寫入檔案的資訊緩衝區,count為要寫入資訊的長度,ppos為當前的偏移位置,這個值通常是用來判斷寫檔案是否越界)
傳送資料給裝置.。如果 NULL, -EINVAL 返回給呼叫 write 系統呼叫的程式. 如果非負, 返回值代表成功寫的位元組數。
(注:這個操作和上面的對檔案進行讀的操作均為阻塞操作)
6、ssize_t (*aio_write)(struct kiocb *, const char __user * buffer, size_t count, loff_t * ppos);
初始化裝置上的一個非同步寫.引數型別同aio_read()函式;
7、int (*readdir) (struct file * filp, void *, filldir_t);
對於裝置檔案這個成員應當為 NULL; 它用來讀取目錄, 並且僅對檔案系統有用.
8、unsigned int (*poll) (struct file *, struct poll_table_struct *);
(這是一個裝置驅動中的輪詢函式,第一個引數為file結構指標,第二個為輪詢表指標)
這個函式返回裝置資源的可獲取狀態,即POLLIN,POLLOUT,POLLPRI,POLLERR,POLLNVAL等巨集的位“或”結果。每個巨集都表明裝置的一種狀態,如:POLLIN(定義為0x0001)意味著裝置可以無阻塞的讀,POLLOUT(定義為0x0004)意味著裝置可以無阻塞的寫。
(poll 方法是 3 個系統呼叫的後端: poll, epoll, 和 select, 都用作查詢對一個或多個檔案描述符的讀或寫是否會阻塞.poll 方法應當返回一個位掩碼指示是否非阻塞的讀或寫是可能的, 並且, 可能地, 提供給核心資訊用來使呼叫程序睡眠直到 I/O 變為可能. 如果一個驅動的 poll 方法為 NULL, 裝置假定為不阻塞地可讀可寫.
(這裡通常將裝置看作一個檔案進行相關的操作,而輪詢操作的取值直接關係到裝置的響應情況,可以是阻塞操作結果,同時也可以是非阻塞操作結果)
9、int (*ioctl) (struct inode *inode, struct file *filp, unsigned int cmd, unsigned long arg);
(inode 和 filp 指標是對應應用程式傳遞的檔案描述符 fd 的值, 和傳遞給 open 方法的相同引數.cmd 引數從使用者那裡不改變地傳下來, 並且可選的引數 arg 引數以一個 unsigned long 的形式傳遞, 不管它是否由使用者給定為一個整數或一個指標.如果呼叫程式不傳遞第 3 個引數, 被驅動操作收到的 arg 值是無定義的.因為型別檢查在這個額外引數上被關閉, 編譯器不能警告你如果一個無效的引數被傳遞給 ioctl, 並且任何關聯的錯誤將難以查詢.)
ioctl 系統呼叫提供了發出裝置特定命令的方法(例如格式化軟盤的一個磁軌, 這不是讀也不是寫). 另外, 幾個 ioctl 命令被核心識別而不必引用 fops 表.如果裝置不提供 ioctl 方法, 對於任何未事先定義的請求(-ENOTTY, "裝置無這樣的 ioctl"), 系統呼叫返回一個錯誤.
10、int (*mmap) (struct file *, struct vm_area_struct *);
mmap 用來請求將裝置記憶體對映到程序的地址空間。 如果這個方法是 NULL, mmap 系統呼叫返回 -ENODEV.
(如果想對這個函式有個徹底的瞭解,那麼請看有關“程序地址空間”介紹的書籍)
11、int (*open) (struct inode * inode , struct file * filp ) ;
(inode 為檔案節點,這個節點只有一個,無論使用者開啟多少個檔案,都只是對應著一個inode結構;但是filp就不同,只要開啟一個檔案,就對應著一個file結構體,file結構體通常用來追蹤檔案在執行時的狀態資訊)
儘管這常常是對裝置檔案進行的第一個操作, 不要求驅動宣告一個對應的方法.
如果這個項是 NULL, 裝置開啟一直成功, 但是你的驅動不會得到通知.與open()函式對應的是release()函式。
12、int (*flush) (struct file *);
flush 操作在程序關閉它的裝置檔案描述符的拷貝時呼叫;
它應當執行(並且等待)裝置的任何未完成的操作.這個必須不要和使用者查詢請求的 fsync 操作混淆了. 當前, flush 在很少驅動中使用;SCSI 磁帶驅動使用它, 例如, 為確保所有寫的資料在裝置關閉前寫到磁帶上. 如果 flush 為 NULL, 核心簡單地忽略使用者應用程式的請求.
13、int (*release) (struct inode *, struct file *);
release ()函式當最後一個開啟裝置的使用者程序執行close()系統呼叫的時候,核心將呼叫驅動程式release()函式:
void release(struct inode inode,struct file *file),release函式的主要任務是清理未結束的輸入輸出操作,釋放資源,使用者自定義排他標誌的復位等。在檔案結構被釋放時引用這個操作. 如同 open, release 可以為 NULL.
14、int(*synch)(struct file *,struct dentry *,int datasync);
重新整理待處理的資料,允許程序把所有的髒緩衝區重新整理到磁碟。
15、int (*aio_fsync)(struct kiocb *, int);
這是 fsync 方法的非同步版本.所謂的fsync方法是一個系統呼叫函式。系統呼叫fsync把檔案所指定的檔案的所有髒緩衝區寫到磁碟中(如果需要,還包括存有索引節點的緩衝區)。相應的服務例程獲得檔案物件的地址,並隨後呼叫fsync方法。通常這個方法以呼叫函式__writeback_single_inode()結束,這個函式把與被選中的索引節點相關的髒頁和索引節點本身都寫回磁碟
16、int (*fasync) (int, struct file *, int);
這個函式是系統支援非同步通知的裝置驅動,下面是這個函式的模板:
static int ***_fasync(int fd,struct file *filp,int mode)
{
struct ***_dev * dev=filp->private_data;
return fasync_helper(fd,filp,mode,&dev->async_queue);//第四個引數為 fasync_struct結構體指標的指標。
//這個函式是用來處理FASYNC標誌的函式。(FASYNC:表示相容BSD的fcntl同步操作)當這個標誌改變時,驅動程式中的fasync()函式將得到執行。 (注:感覺這個‘標誌'詞用的並不恰當)
}
此操作用來通知裝置它的 FASYNC 標誌的改變. 非同步通知是一個高階的主題, 在第 6 章中描述.這個成員可以是NULL 如果驅動不支援非同步通知.17、int (*lock) (struct file *, int, struct file_lock *);
lock 方法用來實現檔案加鎖; 加鎖對常規檔案是必不可少的特性, 但是裝置驅動幾乎從不實現它.
18、ssize_t (*readv) (struct file *, const struct iovec *, unsigned long, loff_t *);
ssize_t (*writev) (struct file *, const struct iovec *, unsigned long, loff_t *);
這些方法實現發散/匯聚讀和寫操作. 應用程式偶爾需要做一個包含多個記憶體區的單個讀或寫操作;這些系統呼叫允許它們這樣做而不必對資料進行額外拷貝. 如果這些函式指標為 NULL, read 和 write 方法被呼叫( 可能多於一次 ).
19、ssize_t (*sendfile)(struct file *, loff_t *, size_t, read_actor_t, void *);
這個方法實現 sendfile 系統呼叫的讀, 使用最少的拷貝從一個檔案描述符搬移資料到另一個.
例如, 它被一個需要傳送檔案內容到一個網路連線的 web 伺服器使用. 裝置驅動常常使 sendfile 為 NULL.
20、ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
sendpage 是 sendfile 的另一半; 它由核心呼叫來發送資料, 一次一頁, 到對應的檔案. 裝置驅動實際上不實現 sendpage.
21、unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
這個方法的目的是在程序的地址空間找一個合適的位置來對映在底層裝置上的記憶體段中。這個任務通常由記憶體管理程式碼進行; 這個方法存在為了使驅動能強制特殊裝置可能有的任何的對齊請求. 大部分驅動可以置這個方法為 NULL.[10]
22、int (*check_flags)(int)
這個方法允許模組檢查傳遞給 fnctl(F_SETFL...) 呼叫的標誌.
23、int (*dir_notify)(struct file *, unsigned long);
這個方法在應用程式使用 fcntl 來請求目錄改變通知時呼叫. 只對檔案系統有用; 驅動不需要實現 dir_notify.