DebugFS,顧名思義,是一種用于內(nèi)核調(diào)試的虛擬文件系統(tǒng),內(nèi)核開發(fā)者通過debugfs和用戶空間交換數(shù)據(jù)咆瘟。類似的虛擬文件系統(tǒng)還有procfs和sysfs等,這幾種虛擬文件系統(tǒng)都并不實際存儲在硬盤上诽里,而是Linux內(nèi)核運行起來后才建立起來搞疗。
通常情況下,最常用的內(nèi)核調(diào)試手段是printk须肆。但printk并不是所有情況都好用,比如打印的數(shù)據(jù)可能過多桩皿,我們真正關心的數(shù)據(jù)在大量的輸出里不是那么一目了然豌汇;或者我們在調(diào)試時可能需要修改某些內(nèi)核變量,這種情況下printk就無能為力泄隔,而如果為了修改某個值重新編譯內(nèi)核或者驅動又過于低效拒贱,此時就需要一個臨時的文件系統(tǒng)可以把我們需要關心的數(shù)據(jù)映射到用戶空間。在過去佛嬉,procfs可以實現(xiàn)這個目的逻澳,到了2.6時代,新引入的sysfs也同樣可以實現(xiàn)暖呕,但不論是procfs或是sysfs斜做,用它們來實現(xiàn)某些debug的需求,似乎偏離了它們創(chuàng)建的本意湾揽。比如procfs瓤逼,其目的是反映進程的狀態(tài)信息;而sysfs主要用于Linux設備模型库物。不論是procfs或是sysfs的接口應該保持相對穩(wěn)定霸旗,因為用戶態(tài)程序很可能會依賴它們。當然戚揭,如果我們只是臨時借用procfs或者sysfs來作debug之用诱告,在代碼發(fā)布之前將相關調(diào)試代碼刪除也無不可。但如果相關的調(diào)試借口要在相當長的一段時間內(nèi)存在于內(nèi)核之中民晒,就不太適合放在procfs和sysfs里了精居。故此,debugfs應運而生镀虐。
默認情況下箱蟆,debugfs會被掛載在目錄/sys/kernel/debug之下,如果您的發(fā)行版里沒有自動掛載刮便,可以用如下命令手動完成:
mount -t debugfs none /your/debugfs/dir
Linux內(nèi)核為debugfs提供了非常簡潔的API空猜,本文接下來將以一個實作為例來介紹,sample code可以從這里下載。
這個實作會在debugfs中建立如下的目錄結構:
其中辈毯,a對應模塊中的一個u8類型的變量坝疼,b和subdir下面的c都是對應模塊里的一個字符數(shù)組,只是它們的實現(xiàn)方式不同谆沃。
在module_init里钝凶,我們首先要建立根目錄mydebug:
my_debugfs_root = debugfs_create_dir("mydebug", NULL);
第一個參數(shù)是目錄的名稱,第二個參數(shù)用來指定這個目錄的上級目錄唁影,如果是NULL耕陷,則表示是放在debugfs的根目錄里。
子目錄也是用debugfs_create_dir來實現(xiàn):
sub_dir = debugfs_create_dir("subdir", my_debugfs_root);
建立文件a的代碼非常簡單:
debugfs_create_u8("a", 0644, my_debugfs_root, &a);
這表示文件名為“a”据沈,文件屬性是0644哟沫,父目錄是上面建立的“mydebug”,對應的變量是模塊中的a锌介。
Linux內(nèi)核還提供了其他一些創(chuàng)建debugfs文件的API嗜诀,請參考本文的附錄币砂。
b是一個32-bytes的字符數(shù)組绵估,在debugfs里,數(shù)組可以用blob wrapper來實現(xiàn)亲族。
char hello[32] = "Hello world!\n";
structdebugfs_blob_wrapper b;
b.data = (void*)hello;
b.size = strlen(hello) + 1;
debugfs_create_blob("b", 0644, my_debugfs_root, &b);
這里需要注意的是崔慧,blob wrapper定義的數(shù)據(jù)只能是只讀的拂蝎。在本例中,雖然我們把文件b的權限設定為0644尊浪,但實際這個文件還是只讀的匣屡,如果試圖改寫這個文件,系統(tǒng)將提示出錯拇涤。
如果需要對內(nèi)核數(shù)組進行寫的動作捣作,blob wrapper就無法滿足要求,我們只能通過自己定義文件操作來實現(xiàn)鹅士。在這個實作里券躁,可以參考文件c的實現(xiàn)。c和b在模塊里對應著同一塊字符數(shù)組掉盅,不同的是也拜,b是只讀的,而c通過自定義的文件操作同時實現(xiàn)了讀和寫趾痘。
staticint c_open(structinode *inode, structfile *filp)
{
filp->private_data = inode->i_private;
return0;
}
staticssize_t c_read(structfile *filp, char__user *buffer,
size_tcount, loff_t *ppos)
{
if(*ppos >= 32)
return0;
if(*ppos + count > 32)
count = 32 - *ppos;
if(copy_to_user(buffer, hello + *ppos, count))
return-EFAULT;
*ppos += count;
returncount;
}
staticssize_t c_write(structfile *filp, constchar __user *buffer,
size_tcount, loff_t *ppos)
{
if(*ppos >= 32)
return0;
if(*ppos + count > 32)
count = 32 - *ppos;
if(copy_from_user(hello + *ppos, buffer, count))
return-EFAULT;
*ppos += count;
returncount;
}
structfile_operations c_fops = {
.owner = THIS_MODULE,
.open = c_open,
.read = c_read,
.write = c_write,
};
debugfs_create_file("c", 0644, sub_dir, NULL, &c_fops);
注:代碼里慢哈,c_open其實并沒有任何用處,因為c_read和c_write直接引用了全局變量hello永票。這里卵贱,我們也可以換一種寫法滥沫,在read/write函數(shù)里用filp->private_data來引用字符數(shù)組hello。
到這里键俱,三個文件和子目錄已經(jīng)創(chuàng)建完畢兰绣。在module_exit中,我們要記得釋放創(chuàng)建的數(shù)據(jù)编振。
debugfs_remove_recursive(my_debugfs_root);
debugfs_remove_recursive可以幫我們逐步移除每個分配的dentry缀辩,如果您想一個一個手動的移除,也可以直接調(diào)用debugfs_remove踪央。