3.3.?一些重要數(shù)據(jù)結(jié)構(gòu)

如同你想象的, 注冊設(shè)備編號僅僅是驅(qū)動代碼必須進行的諸多任務(wù)中的第一個. 我們將很快看到其他重要的驅(qū)動組件, 但首先需要涉及一個別的. 大部分的基礎(chǔ)性的驅(qū)動操作包括 3 個重要的內(nèi)核數(shù)據(jù)結(jié)構(gòu), 稱為 file_operations, file, 和 inode. 需要對這些結(jié)構(gòu)的基本了解才能夠做大量感興趣的事情, 因此我們現(xiàn)在在進入如何實現(xiàn)基礎(chǔ)性驅(qū)動操作的細節(jié)之前, 會快速查看每一個.

3.3.1.?文件操作

到現(xiàn)在, 我們已經(jīng)保留了一些設(shè)備編號給我們使用, 但是我們還沒有連接任何我們設(shè)備操作到這些編號上. file_operation 結(jié)構(gòu)是一個字符驅(qū)動如何建立這個連接. 這個結(jié)構(gòu), 定義在 <linux/fs.h>, 是一個函數(shù)指針的集合. 每個打開文件(內(nèi)部用一個 file 結(jié)構(gòu)來代表, 稍后我們會查看)與它自身的函數(shù)集合相關(guān)連( 通過包含一個稱為 f_op 的成員, 它指向一個 file_operations 結(jié)構(gòu)). 這些操作大部分負責實現(xiàn)系統(tǒng)調(diào)用, 因此, 命名為 open, read, 等等. 我們可以認為文件是一個"對象"并且其上的函數(shù)操作稱為它的"方法", 使用面向?qū)ο缶幊痰男g(shù)語來表示一個對象聲明的用來操作對象的動作. 這是我們在 Linux 內(nèi)核中看到的第一個面向?qū)ο缶幊痰默F(xiàn)象, 后續(xù)章中我們會看到更多.

傳統(tǒng)上, 一個 file_operation 結(jié)構(gòu)或者其一個指針稱為 fops( 或者它的一些變體). 結(jié)構(gòu)中的每個成員必須指向驅(qū)動中的函數(shù), 這些函數(shù)實現(xiàn)一個特別的操作, 或者對于不支持的操作留置為 NULL. 當指定為 NULL 指針時內(nèi)核的確切的行為是每個函數(shù)不同的, 如同本節(jié)后面的列表所示.

下面的列表介紹了一個應(yīng)用程序能夠在設(shè)備上調(diào)用的所有操作. 我們已經(jīng)試圖保持列表簡短, 這樣它可作為一個參考, 只是總結(jié)每個操作和在 NULL 指針使用時的缺省內(nèi)核行為.

在你通讀 file_operations 方法的列表時, 你會注意到不少參數(shù)包含字串 user. 這種注解是一種文檔形式, 注意, 一個指針是一個不能被直接解引用的用戶空間地址. 對于正常的編譯, user 沒有效果, 但是它可被外部檢查軟件使用來找出對用戶空間地址的錯誤使用.

本章剩下的部分, 在描述一些其他重要數(shù)據(jù)結(jié)構(gòu)后, 解釋了最重要操作的角色并且給了提示, 告誡和真實代碼例子. 我們推遲討論更復(fù)雜的操作到后面章節(jié), 因為我們還不準備深入如內(nèi)存管理, 阻塞操作, 和異步通知.

struct module *owner
第一個 file_operations 成員根本不是一個操作; 它是一個指向擁有這個結(jié)構(gòu)的模塊的指針. 這個成員用來在它的操作還在被使用時阻止模塊被卸載. 幾乎所有時間中, 它被簡單初始化為 THIS_MODULE, 一個在 <linux/module.h> 中定義的宏.

loff_t (llseek) (struct file , loff_t, int);
llseek 方法用作改變文件中的當前讀/寫位置, 并且新位置作為(正的)返回值. loff_t 參數(shù)是一個"long offset", 并且就算在 32位平臺上也至少 64 位寬. 錯誤由一個負返回值指示. 如果這個函數(shù)指針是 NULL, seek 調(diào)用會以潛在地無法預(yù)知的方式修改 file 結(jié)構(gòu)中的位置計數(shù)器( 在"file 結(jié)構(gòu)" 一節(jié)中描述).

ssize_t (read) (struct file , char __user , size_t, loff_t );
用來從設(shè)備中獲取數(shù)據(jù). 在這個位置的一個空指針導(dǎo)致 read 系統(tǒng)調(diào)用以 -EINVAL("Invalid argument") 失敗. 一個非負返回值代表了成功讀取的字節(jié)數(shù)( 返回值是一個 "signed size" 類型, 常常是目標平臺本地的整數(shù)類型).

ssize_t (aio_read)(struct kiocb , char __user *, size_t, loff_t);
初始化一個異步讀 -- 可能在函數(shù)返回前不結(jié)束的讀操作. 如果這個方法是 NULL, 所有的操作會由 read 代替進行(同步地).

ssize_t (write) (struct file , const char __user , size_t, loff_t );
發(fā)送數(shù)據(jù)給設(shè)備. 如果 NULL, -EINVAL 返回給調(diào)用 write 系統(tǒng)調(diào)用的程序. 如果非負, 返回值代表成功寫的字節(jié)數(shù).

ssize_t (aio_write)(struct kiocb , const char __user , size_t, loff_t );
初始化設(shè)備上的一個異步寫.

int (readdir) (struct file , void *, filldir_t);
對于設(shè)備文件這個成員應(yīng)當為 NULL; 它用來讀取目錄, 并且僅對文件系統(tǒng)有用.

unsigned int (poll) (struct file , struct poll_table_struct *);
poll 方法是 3 個系統(tǒng)調(diào)用的后端: poll, epoll, 和 select, 都用作查詢對一個或多個文件描述符的讀或?qū)懯欠駮枞? poll 方法應(yīng)當返回一個位掩碼指示是否非阻塞的讀或?qū)懯强赡艿? 并且, 可能地, 提供給內(nèi)核信息用來使調(diào)用進程睡眠直到 I/O 變?yōu)榭赡? 如果一個驅(qū)動的 poll 方法為 NULL, 設(shè)備假定為不阻塞地可讀可寫.

int (ioctl) (struct inode , struct file *, unsigned int, unsigned long);
ioctl 系統(tǒng)調(diào)用提供了發(fā)出設(shè)備特定命令的方法(例如格式化軟盤的一個磁道, 這不是讀也不是寫). 另外, 幾個 ioctl 命令被內(nèi)核識別而不必引用 fops 表. 如果設(shè)備不提供 ioctl 方法, 對于任何未事先定義的請求(-ENOTTY, "設(shè)備無這樣的 ioctl"), 系統(tǒng)調(diào)用返回一個錯誤.

int (mmap) (struct file , struct vm_area_struct *);
mmap 用來請求將設(shè)備內(nèi)存映射到進程的地址空間. 如果這個方法是 NULL, mmap 系統(tǒng)調(diào)用返回 -ENODEV.

int (open) (struct inode , struct file *);
盡管這常常是對設(shè)備文件進行的第一個操作, 不要求驅(qū)動聲明一個對應(yīng)的方法. 如果這個項是 NULL, 設(shè)備打開一直成功, 但是你的驅(qū)動不會得到通知.

int (flush) (struct file );
flush 操作在進程關(guān)閉它的設(shè)備文件描述符的拷貝時調(diào)用; 它應(yīng)當執(zhí)行(并且等待)設(shè)備的任何未完成的操作. 這個必須不要和用戶查詢請求的 fsync 操作混淆了. 當前, flush 在很少驅(qū)動中使用; SCSI 磁帶驅(qū)動使用它, 例如, 為確保所有寫的數(shù)據(jù)在設(shè)備關(guān)閉前寫到磁帶上. 如果 flush 為 NULL, 內(nèi)核簡單地忽略用戶應(yīng)用程序的請求.

int (release) (struct inode , struct file *);
在文件結(jié)構(gòu)被釋放時引用這個操作. 如同 open, release 可以為 NULL.

int (fsync) (struct file , struct dentry *, int);
這個方法是 fsync 系統(tǒng)調(diào)用的后端, 用戶調(diào)用來刷新任何掛著的數(shù)據(jù). 如果這個指針是 NULL, 系統(tǒng)調(diào)用返回 -EINVAL.

int (aio_fsync)(struct kiocb , int);
這是 fsync 方法的異步版本.

int (fasync) (int, struct file , int);
這個操作用來通知設(shè)備它的 FASYNC 標志的改變. 異步通知是一個高級的主題, 在第 6 章中描述. 這個成員可以是NULL 如果驅(qū)動不支持異步通知.

int (lock) (struct file , int, struct file_lock *);
lock 方法用來實現(xiàn)文件加鎖; 加鎖對常規(guī)文件是必不可少的特性, 但是設(shè)備驅(qū)動幾乎從不實現(xiàn)它.

ssize_t (readv) (struct file , const struct iovec , unsigned long, loff_t );ssize_t (writev) (struct file , const struct iovec , unsigned long, loff_t );
這些方法實現(xiàn)發(fā)散/匯聚讀和寫操作. 應(yīng)用程序偶爾需要做一個包含多個內(nèi)存區(qū)的單個讀或?qū)懖僮? 這些系統(tǒng)調(diào)用允許它們這樣做而不必對數(shù)據(jù)進行額外拷貝. 如果這些函數(shù)指針為 NULL, read 和 write 方法被調(diào)用( 可能多于一次 ).

ssize_t (sendfile)(struct file , loff_t , size_t, read_actor_t, void );
這個方法實現(xiàn) sendfile 系統(tǒng)調(diào)用的讀, 使用最少的拷貝從一個文件描述符搬移數(shù)據(jù)到另一個. 例如, 它被一個需要發(fā)送文件內(nèi)容到一個網(wǎng)絡(luò)連接的 web 服務(wù)器使用. 設(shè)備驅(qū)動常常使 sendfile 為 NULL.

ssize_t (sendpage) (struct file , struct page , int, size_t, loff_t , int);
sendpage 是 sendfile 的另一半; 它由內(nèi)核調(diào)用來發(fā)送數(shù)據(jù), 一次一頁, 到對應(yīng)的文件. 設(shè)備驅(qū)動實際上不實現(xiàn) sendpage.

unsigned long (get_unmapped_area)(struct file , unsigned long, unsigned long, unsigned long, unsigned long);
這個方法的目的是在進程的地址空間找一個合適的位置來映射在底層設(shè)備上的內(nèi)存段中. 這個任務(wù)通常由內(nèi)存管理代碼進行; 這個方法存在為了使驅(qū)動能強制特殊設(shè)備可能有的任何的對齊請求. 大部分驅(qū)動可以置這個方法為 NULL.[10]

int (*check_flags)(int)
這個方法允許模塊檢查傳遞給 fnctl(F_SETFL...) 調(diào)用的標志.

int (dir_notify)(struct file , unsigned long);
這個方法在應(yīng)用程序使用 fcntl 來請求目錄改變通知時調(diào)用. 只對文件系統(tǒng)有用; 驅(qū)動不需要實現(xiàn) dir_notify.

scull 設(shè)備驅(qū)動只實現(xiàn)最重要的設(shè)備方法. 它的 file_operations 結(jié)構(gòu)是如下初始化的:

struct file_operations scull_fops = {
 .owner =  THIS_MODULE, 
 .llseek =  scull_llseek, 
 .read =  scull_read, 
 .write =  scull_write, 
 .ioctl =  scull_ioctl, 
 .open =  scull_open, 
 .release =  scull_release,  
};  

這個聲明使用標準的 C 標記式結(jié)構(gòu)初始化語法. 這個語法是首選的, 因為它使驅(qū)動在結(jié)構(gòu)定義的改變之間更加可移植, 并且, 有爭議地, 使代碼更加緊湊和可讀. 標記式初始化允許結(jié)構(gòu)成員重新排序; 在某種情況下, 真實的性能提高已經(jīng)實現(xiàn), 通過安放經(jīng)常使用的成員的指針在相同硬件高速存儲行中.

3.3.2.?文件結(jié)構(gòu)

struct file, 定義于 <linux/fs.h>, 是設(shè)備驅(qū)動中第二個最重要的數(shù)據(jù)結(jié)構(gòu). 注意 file 與用戶空間程序的 FILE 指針沒有任何關(guān)系. 一個 FILE 定義在 C 庫中, 從不出現(xiàn)在內(nèi)核代碼中. 一個 struct file, 另一方面, 是一個內(nèi)核結(jié)構(gòu), 從不出現(xiàn)在用戶程序中.

文件結(jié)構(gòu)代表一個打開的文件. (它不特定給設(shè)備驅(qū)動; 系統(tǒng)中每個打開的文件有一個關(guān)聯(lián)的 struct file 在內(nèi)核空間). 它由內(nèi)核在 open 時創(chuàng)建, 并傳遞給在文件上操作的任何函數(shù), 直到最后的關(guān)閉. 在文件的所有實例都關(guān)閉后, 內(nèi)核釋放這個數(shù)據(jù)結(jié)構(gòu).

在內(nèi)核源碼中, struct file 的指針常常稱為 file 或者 filp("file pointer"). 我們將一直稱這個指針為 filp 以避免和結(jié)構(gòu)自身混淆. 因此, file 指的是結(jié)構(gòu), 而 filp 是結(jié)構(gòu)指針.

struct file 的最重要成員在這展示. 如同在前一節(jié), 第一次閱讀可以跳過這個列表. 但是, 在本章后面, 當我們面對一些真實 C 代碼時, 我們將更詳細討論這些成員.

mode_t f_mode;
文件模式確定文件是可讀的或者是可寫的(或者都是), 通過位 FMODE_READ 和 FMODE_WRITE. 你可能想在你的 open 或者 ioctl 函數(shù)中檢查這個成員的讀寫許可, 但是你不需要檢查讀寫許可, 因為內(nèi)核在調(diào)用你的方法之前檢查. 當文件還沒有為那種存取而打開時讀或?qū)懙钠髨D被拒絕, 驅(qū)動甚至不知道這個情況.

loff_t f_pos;
當前讀寫位置. loff_t 在所有平臺都是 64 位( 在 gcc 術(shù)語里是 long long ). 驅(qū)動可以讀這個值, 如果它需要知道文件中的當前位置, 但是正常地不應(yīng)該改變它; 讀和寫應(yīng)當使用它們作為最后參數(shù)而收到的指針來更新一個位置, 代替直接作用于 filp->f_pos. 這個規(guī)則的一個例外是在 llseek 方法中, 它的目的就是改變文件位置.

unsigned int f_flags;
這些是文件標志, 例如 O_RDONLY, O_NONBLOCK, 和 O_SYNC. 驅(qū)動應(yīng)當檢查 O_NONBLOCK 標志來看是否是請求非阻塞操作( 我們在第一章的"阻塞和非阻塞操作"一節(jié)中討論非阻塞 I/O ); 其他標志很少使用. 特別地, 應(yīng)當檢查讀/寫許可, 使用 f_mode 而不是 f_flags. 所有的標志在頭文件 <linux/fcntl.h> 中定義.

struct file_operations *f_op;
和文件關(guān)聯(lián)的操作. 內(nèi)核安排指針作為它的 open 實現(xiàn)的一部分, 接著讀取它當它需要分派任何的操作時. filp->f_op 中的值從不由內(nèi)核保存為后面的引用; 這意味著你可改變你的文件關(guān)聯(lián)的文件操作, 在你返回調(diào)用者之后新方法會起作用. 例如, 關(guān)聯(lián)到主編號 1 (/dev/null, /dev/zero, 等等)的 open 代碼根據(jù)打開的次編號來替代 filp->f_op 中的操作. 這個做法允許實現(xiàn)幾種行為, 在同一個主編號下而不必在每個系統(tǒng)調(diào)用中引入開銷. 替換文件操作的能力是面向?qū)ο缶幊痰?方法重載"的內(nèi)核對等體.

void *private_data;
open 系統(tǒng)調(diào)用設(shè)置這個指針為 NULL, 在為驅(qū)動調(diào)用 open 方法之前. 你可自由使用這個成員或者忽略它; 你可以使用這個成員來指向分配的數(shù)據(jù), 但是接著你必須記住在內(nèi)核銷毀文件結(jié)構(gòu)之前, 在 release 方法中釋放那個內(nèi)存. private_data 是一個有用的資源, 在系統(tǒng)調(diào)用間保留狀態(tài)信息, 我們大部分例子模塊都使用它.

struct dentry *f_dentry;
關(guān)聯(lián)到文件的目錄入口( dentry )結(jié)構(gòu). 設(shè)備驅(qū)動編寫者正常地不需要關(guān)心 dentry 結(jié)構(gòu), 除了作為 filp->f_dentry->d_inode 存取 inode 結(jié)構(gòu).

真實結(jié)構(gòu)有多幾個成員, 但是它們對設(shè)備驅(qū)動沒有用處. 我們可以安全地忽略這些成員, 因為驅(qū)動從不創(chuàng)建文件結(jié)構(gòu); 它們真實存取別處創(chuàng)建的結(jié)構(gòu).

3.3.3.?inode 結(jié)構(gòu)

inode 結(jié)構(gòu)由內(nèi)核在內(nèi)部用來表示文件. 因此, 它和代表打開文件描述符的文件結(jié)構(gòu)是不同的. 可能有代表單個文件的多個打開描述符的許多文件結(jié)構(gòu), 但是它們都指向一個單個 inode 結(jié)構(gòu).

inode 結(jié)構(gòu)包含大量關(guān)于文件的信息. 作為一個通用的規(guī)則, 這個結(jié)構(gòu)只有 2 個成員對于編寫驅(qū)動代碼有用:

dev_t i_rdev;
對于代表設(shè)備文件的節(jié)點, 這個成員包含實際的設(shè)備編號.

struct cdev *i_cdev;
struct cdev 是內(nèi)核的內(nèi)部結(jié)構(gòu), 代表字符設(shè)備; 這個成員包含一個指針, 指向這個結(jié)構(gòu), 當節(jié)點指的是一個字符設(shè)備文件時.

i_rdev 類型在 2.5 開發(fā)系列中改變了, 破壞了大量的驅(qū)動. 作為一個鼓勵更可移植編程的方法, 內(nèi)核開發(fā)者已經(jīng)增加了 2 個宏, 可用來從一個 inode 中獲取主次編號:

unsigned int iminor(struct inode *inode);
unsigned int imajor(struct inode *inode);

為了不要被下一次改動抓住, 應(yīng)當使用這些宏代替直接操作 i_rdev.

[10] 注意, release 不是每次進程調(diào)用 close 時都被調(diào)用. 無論何時共享一個文件結(jié)構(gòu)(例如, 在一個 fork 或 dup 之后), release 不會調(diào)用直到所有的拷貝都關(guān)閉了. 如果你需要在任一拷貝關(guān)閉時刷新掛著的數(shù)據(jù), 你應(yīng)當實現(xiàn) flush 方法.